Skip to content

AGENTS.md

Latest commit

 

History

History
43 lines (31 loc) · 1.6 KB

AGENTS.md

File metadata and controls

43 lines (31 loc) · 1.6 KB
Raw

AGENTS Instructions

Development Environment

  • Use nix develop.
  • This project uses docker compose for the development environment.
  • The development stack can be started using docker compose up --build --detach.

Code Style

  • Use one, only or first from more_itertools instead of [0].

GraphQL Client

  • autogenerated_graphql_client/ CANNOT be edited manually.
  • Use ariadne-codegen client if queries.graphql has changed.

Testing Instructions

  • Prefer integration tests over unit tests, and avoid using mocks.
  • Use fixtures from tests/conftest.py and tests/integration/conftest.py when writing tests.
  • Never run pytest directly on the host.
  • Always use docker compose run --rm sdtool-plus pytest ... to run tests. This requires starting the development environment and running docker compose stop sdtool-plus first.
  • You will need a running os2mo stack to run integration tests, you can find os2mo here: https://github.com/OS2mo
  • Never run all tests; it takes too long. Only run relevant tests.

Commit Instructions

  • Branch names should include a ticket number, e.g. 69176-related-owner.
  • Make sure pre-commit run --all-files passes before committing.
  • Commits must adhere to the conventional commits style and include a ticket number, e.g.:
    • feat: [#68002] allow reading connected addresses through an engagement.
    • fix: [#68002] don't sleep when no events.

Code Review

  • You do not have access to the remote, so you can't look up the merge request/pull request
  • Assume that you need to review the commits from the base of the branch to the head