Skip to content

AGENTS.md

Latest commit

 

History

History
50 lines (39 loc) · 2.73 KB

AGENTS.md

File metadata and controls

50 lines (39 loc) · 2.73 KB

AGENTS.md

Codex PR Review Rules

Apply these rules to all new or modified code in this repository.

  1. Units on numeric literals

    • Add a trailing inline unit comment to each numeric literal assignment/definition when the quantity has physical meaning.
    • Format: value = 1.2 # [s].
    • Use SI-style bracketed units (examples: [s], [m], [kg], [rad], [m/s], [N*m]).

  2. Doc comment format

    • All new/updated Python docstrings and Doxygen comments must be valid, well-formed reStructuredText (.rst) markup.
    • Keep parameter, return, and note sections consistent and renderable by Sphinx/Doxygen.

  3. Spelling quality

    • No misspellings in newly added/modified identifiers, comments, docstrings, Doxygen blocks, user-facing strings, or docs text.

  4. Coding-guideline conformance

    • New code must follow Basilisk coding guidelines in: docs/source/Support/Developer/CodingGuidlines.rst.
    • Respect language-specific foundations referenced there (C/C++: Stroustrup/Sutter style basis; Python: PEP 8), plus Basilisk naming and message conventions.
    • For legacy non-conforming files: keep style consistent for minor edits; use major refactors to move code toward guideline compliance.
    • Follow the checkout recommendation in docs/source/Support/Developer/bskModuleCheckoutList.rst

  5. PR metadata requirements

    • For normal PRs, include one release-note snippet in: docs/source/Support/bskReleaseNotesSnippets/.
    • Ensure snippet content follows: docs/source/Support/bskReleaseNotesSnippets/README.md.
    • Do not edit docs/source/Support/bskReleaseNotes.rst directly for normal PRs.
    • If there is a BSK fix, make sure it is mentioned in the docs/source/Support/bskKnownIssues.rst file.

  6. SysModel documentation requirement

    • Every new SysModel must include a corresponding .rst documentation file.
    • Pattern new module docs after: src/moduleTemplates/cModuleTemplate/cModuleTemplate.rst or src/moduleTemplates/cppModuleTemplate/cppModuleTemplate.rst.

  7. Basilisk Module Creation

    • Ensure new Basilisk modules have a unit test
    • Unit test method needs to have documentation strings
    • Ensure the copyright statement is in new files using the current year

  8. Basilisk Example Files

    • If an example scenario is included in the examples folder, ensure this example has a unit test in src/tests that imports and runs this example file.
    • If the example file includes the enableUnityVisualization() method, ensure the saveFile argument is included but commented out.
    • Ensure new Python example scripts are linked in examples/_default.rst.
    • Ensure any data importing is done in a robust manner supporting Linux, Windows and macOS