-
Notifications
You must be signed in to change notification settings - Fork 51
Open
Description
Description
Update the repository's custom instructions file to include comprehensive Python coding standards, particularly around formatting and docstring requirements. This will ensure consistency across the codebase and make it easier for AI agents and developers to follow project conventions.
Why This Matters
Clear coding standards help maintain code quality, consistency, and readability. By documenting Python formatting rules and docstring requirements in the custom instructions, we ensure that both human developers and AI coding agents follow the same conventions when contributing to the project.
Acceptance Criteria
- Add Python formatting standards (e.g., line length, import organization)
- Document docstring requirements and format (e.g., Google style, NumPy style)
- Include examples of properly formatted code and docstrings
- Specify type hinting requirements
- Document naming conventions for functions, classes, and variables
- Add guidelines for error handling and logging
- Update existing documentation references to point to new standards
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels