Add PR scope guidelines to CONTRIBUTING.md

Clarify what belongs in a PR vs. a Discussion — agent files are always
welcome, but tooling/architecture/bulk changes should start as a
Discussion first. Committed build output will always be closed.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Michael Sitarzewski 2026-03-14 18:15:32 -05:00
parent fa3c12417a
commit 82ba7f4887

View File

@ -241,6 +241,29 @@ quickstart guide wearing an agent costume does not.
## 🔄 Pull Request Process
### What Belongs in a PR (and What Doesn't)
The fastest path to a merged PR is **one markdown file** — a new or improved agent. That's the sweet spot.
For anything beyond that, here's how we keep things smooth:
#### Always welcome as a PR
- Adding a new agent (one `.md` file)
- Improving an existing agent's content, examples, or personality
- Fixing typos or clarifying docs
#### Start a Discussion first
- New tooling, build systems, or CI workflows
- Architectural changes (new directories, new scripts, site generators)
- Changes that touch many files across the repo
- New integration formats or platforms
We love ambitious ideas — a [Discussion](https://github.com/msitarzewski/agency-agents/discussions) just gives the community a chance to align on approach before code gets written. It saves everyone time, especially yours.
#### Things we'll always close
- **Committed build output**: Generated files (`_site/`, compiled assets, converted agent files) should never be checked in. Users run `convert.sh` locally; all output is gitignored.
- **PRs that bulk-modify existing agents** without a prior discussion — even well-intentioned reformatting can create merge conflicts for other contributors.
### Before Submitting
1. **Test Your Agent**: Use it in real scenarios, iterate on feedback