Open
Conversation
Document repo setup, workflows, and guardrails for AI agents.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds AGENTS.md, a comprehensive documentation file designed to guide AI agents (like GitHub Copilot) working with this repository. The document provides a structured overview of the codebase, setup instructions, workflows, and guardrails to help AI tools understand the project context.
Changes:
- Added
AGENTS.mdwith sections covering project overview, repository structure, quickstart commands, development workflows, testing/CI, code style conventions, security guardrails, common tasks, and references to further reading
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
zetter-rpf
reviewed
Feb 23, 2026
| - Seeds (dev): `docker compose run --rm api rails projects:create_all` and | ||
| `docker compose run --rm api rails for_education:seed_a_school_with_lessons_and_students` | ||
| (others in README). | ||
| - DB sync (needs Heroku access): `./bin/db-sync/production-to-local.sh` or `staging-to-local.sh`. |
Contributor
There was a problem hiding this comment.
Should we be encouraging agents to run this?
zetter-rpf
reviewed
Feb 23, 2026
| ## Repository Structure | ||
| - `app/` Rails application code (REST, GraphQL, jobs, views, admin). | ||
| - `config/` environment, initializers, Puma, CORS, credentials. | ||
| - `db/` migrations, seeds, schema helpers; `bin/db-sync/` for pulling Heroku data locally. |
Contributor
There was a problem hiding this comment.
(same as below) - should be be encouraging agents to run bin/db-sync/?
zetter-rpf
approved these changes
Feb 23, 2026
Contributor
zetter-rpf
left a comment
zetter-rpf
left a comment
There was a problem hiding this comment.
Approved - looks like a useful base for us to start with and add things to.
Added a couple of optional comments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document repo setup, workflows, and guardrails for AI agents.
Status
Points for consideration:
What's changed?
Steps to perform after deploying to production