Skip to main content

AI General Rules

Code Structure & Modularity

🧱 Code Structure & Modularity

  • Never create a file longer than 500 lines of code. If a file approaches this limit, refactor by splitting it into modules or helper files.
  • Organize code into clearly separated modules, grouped by feature or responsibility.
  • Use clear, consistent imports (prefer relative imports within packages).

Testing & Reliability

🧪 Testing & Reliability

  • Always create test unit for new features (functions, classes, routes, etc).
  • After updating any logic, check whether existing unit tests need to be updated. If so, do it.
  • Tests should live in a /tests folder mirroring the main app structure.
    • Include at least:
      • 1 test for expected use
      • 1 edge case
      • 1 failure case

Documentation & Explainability

📚 Documentation & Explainability

  • Update README.md when new features are added, dependencies change, or setup steps are modified.
  • Comment non-obvious code and ensure everything is understandable to a mid-level developer.
  • When writing complex logic, add an inline comment explaining the why, not just the what.

AI Behavior Rules

🧠 AI Behavior Rules

  • Never assume missing context. Ask questions if uncertain.
  • Never hallucinate libraries or functions – only use known, verified and open source packages that are free even for commercial use.
  • Always confirm file paths and module names exist before referencing them in code or tests.
  • Never delete or overwrite existing code unless explicitly instructed.