docs: enrich CONTRIBUTING.md and add GitHub issue/PR templates#2591
docs: enrich CONTRIBUTING.md and add GitHub issue/PR templates#2591batmnnn wants to merge 4 commits into
Conversation
6657cc1 to
b7831e1
Compare
Make CONTRIBUTING the human front door (ways to contribute, claim flow, Discord vs GitHub) while pointing at AGENTS.md for deep rules. Add structured bug/feature issue forms and a PR template so that guidance lives in the UI. Fixes AgentWrapper#2590
b7831e1 to
3ff333a
Compare
There was a problem hiding this comment.
Pull request overview
This PR improves the contributor experience by making CONTRIBUTING.md a clearer “front door” and adding GitHub-native issue/PR templates so guidance shows up directly in the GitHub UI.
Changes:
- Expanded
CONTRIBUTING.mdwith contribution paths, a lightweight claim-an-issue flow, and pointers toAGENTS.md/ README / architecture docs. - Added GitHub Issue Forms for bug reports and feature requests, plus issue chooser contact links (Discord + CONTRIBUTING).
- Added a PR template with structured sections and a checklist aligned to repo PR hygiene.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| CONTRIBUTING.md | Expands contributor guidance while keeping it high-level and linking to deeper docs. |
| .github/pull_request_template.md | Adds a structured PR body template and checklist for consistent PRs. |
| .github/ISSUE_TEMPLATE/bug_report.yml | Adds a bug-report issue form focused on reproducibility and environment details. |
| .github/ISSUE_TEMPLATE/feature_request.yml | Adds a feature-request issue form emphasizing problem-first proposals. |
| .github/ISSUE_TEMPLATE/config.yml | Configures issue chooser contact links to Discord and the contributing guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
@illegalcall Hi Dhruv, pinging you for the review. |
illegalcall
left a comment
There was a problem hiding this comment.
Thanks for tightening this up. The content direction looks good to me: CONTRIBUTING.md stays short, points contributors to AGENTS.md / README / architecture docs instead of duplicating setup, and the issue/PR templates collect the right information.
One blocker: the repo Prettier workflow fails on the markdown table in CONTRIBUTING.md. Please run:
npx prettier@3 --write CONTRIBUTING.mdSmall non-blocking suggestion: in .github/pull_request_template.md, [AGENTS.md](AGENTS.md) may not resolve correctly once inserted into a PR body. Consider using [AGENTS.md](../blob/main/AGENTS.md) or the absolute GitHub URL.
Once formatting is fixed, this looks good to merge.
|
@illegalcall cool pushing in a few minutes. |
|
hey |
|
cool let's do connect meanwhile mentioning my thought process over this :
|
Summary
CONTRIBUTING.mdas the human front door: ways to contribute, Discord vs GitHub, claim-an-issue flow, and pointers toAGENTS.md/ README /docs/architecture.md(no setup dump).config.ymlcontact links to Discord and CONTRIBUTING..github/pull_request_template.md(What / Why / How / Testing + checklist aligned with AGENTS PR hygiene).Fixes #2590
Design draft: https://app.notion.com/p/batmnnn/Enhanced-CONTRIBUTING-md-Draft-399b156bc37081ba85d7d3d7256cd854
Test plan
pull_request_template.mdCONTRIBUTING.md: still short, still linksAGENTS.md, uses real labels (good-first-issue,help wanted)AGENTS.mdor runtime/CI code