Skip to content

Document coding standards in custom instructions file #42

@automagicallyio

Description

@automagicallyio

Establish and document consistent coding standards across the project to ensure code quality, maintainability, and team collaboration. This includes Python formatting conventions and docstring requirements that all contributors should follow.

Acceptance Criteria:

  • Create or update .github/copilot-instructions.md file with coding standards
  • Document Python formatting standards (e.g., Black, PEP 8)
  • Define docstring requirements and format (e.g., Google, NumPy, or Sphinx style)
  • Include naming conventions for variables, functions, and classes
  • Add examples of correct and incorrect code patterns
  • Document any project-specific linting rules
  • Update README with reference to coding standards
  • Review and approval by team leads

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions