Skip to content

Update our repository coding standards #2

Description

@github-actions

Clear, documented coding standards keep the codebase consistent and make it easier for new contributors (and Copilot) to produce correct changes. We need to refresh our standards to cover TypeScript formatting rules and docstring/comment expectations so that frontend and backend code follow a single, well-understood convention.

Acceptance criteria

  • TypeScript formatting rules are documented and, where possible, enforced through ESLint
  • Docstring and comment expectations are documented for both Python and TypeScript
  • The relevant .github/instructions files are updated to reflect the standards
  • The README links to or summarizes the updated coding standards
  • scripts/run-lint.sh passes with any newly added rules

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