Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive AI coding instructions and development guidelines to enhance the Python project template's developer experience. It introduces standardized coding practices, AI assistant configurations, and renames a configuration file for better clarity.
Type of Change
Changes Made
New Files:
.cursor/rules/python_guidelines.mdc- Cursor AI editor rules with comprehensive Python coding standards in MDC format.cursorrules- Main Cursor AI editor configuration file with Python best practices.github/ISSUE_TEMPLATE/instructions/python.instructions.md- GitHub issue template with Python coding conventions.github/copilot-instructions.md- GitHub Copilot specific instructions for this Python project template.github/prompts/create-pr-description.prompt.md- Automated PR description generation template with workflow instructionsModified Files:
src/configuration/config_test.py→src/configuration/config_example.py(100% match, improved naming convention)Deleted Files:
None
Technical Details
This PR establishes a comprehensive development guidelines framework that includes:
uvThe renamed configuration file (
config_test.py→config_example.py) better reflects its purpose as an example/template configuration rather than a test file.Testing
Test Results: All existing tests pass (5/5) - no functional changes affect the codebase logic.
Impact Assessment
Breaking Changes:
None - this is purely additive documentation and configuration
Dependencies:
No new dependencies introduced
Performance Impact:
No performance implications - only documentation and configuration files added
Screenshots/Examples
The new instruction files provide consistent coding standards across different AI platforms:
Cursor AI Rules Example: