-
Notifications
You must be signed in to change notification settings - Fork 3
docs: add CONTRIBUTING.md and AGENTS.md #134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR establishes contribution guidelines and AI agent standards for the repository by adding two new documentation files.
- Added CONTRIBUTING.md with comprehensive contribution guidelines including conventional commits, issue references, visual evidence requirements, and code quality standards
- Added AGENTS.md to ensure AI coding tools follow the contribution guidelines
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
File | Description |
---|---|
CONTRIBUTING.md | Establishes project contribution standards covering commit conventions, PR requirements, and code quality expectations |
AGENTS.md | Directs AI coding assistants to follow the contribution guidelines defined in CONTRIBUTING.md |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This came about for me when assigning @copilot to take on easy issues that were opened. It wasn't following conventional commits and I don't want to have to clean up after the "agents" going forwards... |
Add contribution guidelines covering conventional commits, issue references, visual evidence for changes, draft PR workflow, and code quality standards. Add AGENTS.md to ensure AI tools follow contribution guidelines. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2b8f80b
to
4722db4
Compare
- Reorganize CONTRIBUTING.md with clearer section structure - Add Contributing section to README.md linking to CONTRIBUTING.md - List key contribution topics (commit conventions, PR workflow, code quality) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.. AGENTs or CONTRIBUTING could be fleshed out further to provide better context of the goals of the project too:
- reference implementation: stay away from wide optionality and use opinionated best practices, explaining why we did things a certain way. (AI creating PRs automatically should require us to fill out areas where there is ambiguity)
- everything should be documented well: it's a learning resource
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AGENTS.md need a bit more work, it should be instructions for agents, not about how to use agents, since these typically end up in contexts. But I'll follow up on that, I'm just in the process of cleaning up the Synapse one, I'll come back here and do the same
Summary
🤖 Generated with help from Claude Code