Files
growstuff/AGENTS.md
T
Daniel O'Connor ed04f6ed44 Add UI changes section to AGENTS.md
Added guidelines for including visual evidence in pull requests.
2026-10-23 03:08:32 +10:30

1.1 KiB

Notes for coding agents

UI changes

Where possible if creating a pull request, include screenshots or other visual test evidence if your changes are design oriented.

Dependencies

Do not commit or publish changes to ruby versions, gemfiles data or similar if you have had to make changes to the application to run in your sandbox environment/a user has not asked you to.

Specs

Follow the layout advice at https://www.betterspecs.org/:

  • One expectation per example. Name the example for the behaviour it checks.
  • describe for the thing under test, context for a situation, phrased "when ...", "with ..." or "without ...".
  • Keep it descriptions short, and don't start them with "should".
  • Prefer lazy let over instance variables and let!/before setup, and use subject when the thing under test is the same across examples.
  • Use described_class rather than repeating the class name.
  • Extract repeated behaviour into shared examples.
  • Don't mark a feature spec :js unless it needs JavaScript. Without it the spec runs under rack_test, which is much faster than a browser.