Skip to content

Commit aee1d45

Browse files
dblockCopilot
andcommitted
Add AGENTS.md
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 61b7ef9 commit aee1d45

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# AI Agent Instructions
2+
3+
## After Making Code Changes
4+
5+
Always run the following commands before committing:
6+
7+
1. **Fix lint**: `bundle exec rubocop -a`
8+
2. **Update rubocop todo**: `bundle exec rubocop --auto-gen-config`
9+
3. **Run tests**: `bundle exec rspec`
10+
11+
## Changelog
12+
13+
Update [CHANGELOG.md](CHANGELOG.md) for any user-facing change. Add a line at the top under `### Changelog` in the format:
14+
15+
```
16+
* YYYY/MM/DD: Description of change - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
17+
```
18+
19+
## Tests
20+
21+
- Tests live in `spec/` and use RSpec with Fabrication for factories (`spec/fabricators/`).
22+
- Write tests for all new features and bug fixes.
23+
- Requires a local MongoDB instance (see `config/mongoid.yml`).
24+
25+
## Code Style
26+
27+
- Ruby style is enforced via RuboCop (`.rubocop.yml`). Persistent exceptions live in `.rubocop_todo.yml`.
28+
- Do not add new entries to `.rubocop_todo.yml` for code you write — fix the offenses instead.
29+
30+
## Commits and PRs
31+
32+
- Squash commits before merging — one logical commit per PR.

0 commit comments

Comments
 (0)