From 1aa812e59edfa7cfe8ef8cb24b1ef2bda39103a4 Mon Sep 17 00:00:00 2001 From: "Daniel (dB.) Doubrovkine" Date: Sun, 5 Apr 2026 10:47:04 -0400 Subject: [PATCH] Add AGENTS.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- AGENTS.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..8258320 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,32 @@ +# AI Agent Instructions + +## After Making Code Changes + +Always run the following commands before committing: + +1. **Fix lint**: `bundle exec rubocop -a` +2. **Update rubocop todo**: `bundle exec rubocop --auto-gen-config` +3. **Run tests**: `bundle exec rspec` + +## Changelog + +Update [CHANGELOG.md](CHANGELOG.md) for any user-facing change. Add a line at the top under `### Changelog` in the format: + +``` +* YYYY/MM/DD: Description of change - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent). +``` + +## Tests + +- Tests live in `spec/` and use RSpec with Fabrication for factories (`spec/fabricators/`). +- Write tests for all new features and bug fixes. +- Requires a local MongoDB instance (see `config/mongoid.yml`). + +## Code Style + +- Ruby style is enforced via RuboCop (`.rubocop.yml`). Persistent exceptions live in `.rubocop_todo.yml`. +- Do not add new entries to `.rubocop_todo.yml` for code you write — fix the offenses instead. + +## Commits and PRs + +- Squash commits before merging — one logical commit per PR.