Skip to content

CLAUDE.md

Latest commit

 

History

History
15 lines (13 loc) · 1.18 KB

CLAUDE.md

File metadata and controls

15 lines (13 loc) · 1.18 KB

Documentation

  • When making changes that affect the project structure, build/test scripts, or environment variables, make sure to update the DEVELOPMENT.md file.
  • When adding or changing an endpoint, update the DEVELOPMENT.md file with example usage.
  • Update README.md as needed for higher-level, concise information about the project's goals and structure. It should be short and geared towards someone looking for a quick overview of the project.

Code Changes

  • After making code changes, run tests and lint/formatting and make sure they pass. If you need to ignore a lint rule, give an explanation why it's necessary.
  • Where possible, practice test driven development; i.e. write tests for features first, then make sure the tests pass once the feature is implemented.

Model and schema changes

  • Any migrations added should be written to be reversible if possible. For example, foreign key constraints should be named so that they can be dropped.
  • When the database schema is modified, update scripts/populate_db accordingly.
  • YAGNI: If you are considering adding a field to a model that wasn't explicitly requested, ask whether it should be included instead of including it automatically.