Skip to content

docs: enrich CONTRIBUTING.md and add GitHub issue/PR templates#2591

Open
batmnnn wants to merge 4 commits into
AgentWrapper:mainfrom
batmnnn:docs/enrich-contributing-and-templates
Open

docs: enrich CONTRIBUTING.md and add GitHub issue/PR templates#2591
batmnnn wants to merge 4 commits into
AgentWrapper:mainfrom
batmnnn:docs/enrich-contributing-and-templates

Conversation

@batmnnn

@batmnnn batmnnn commented Jul 10, 2026

Copy link
Copy Markdown

Summary

  • Enrich CONTRIBUTING.md as the human front door: ways to contribute, Discord vs GitHub, claim-an-issue flow, and pointers to AGENTS.md / README / docs/architecture.md (no setup dump).
  • Add GitHub issue forms for Bug report and Feature request, plus config.yml contact links to Discord and CONTRIBUTING.
  • Add .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

  • Open https://github.com/AgentWrapper/agent-orchestrator/issues/new/choose (after merge, or via this fork) and confirm Bug report + Feature request forms appear
  • Confirm Discord + Contributing contact links show on the issue chooser
  • Open a draft PR and confirm the body prefills from pull_request_template.md
  • Skim CONTRIBUTING.md: still short, still links AGENTS.md, uses real labels (good-first-issue, help wanted)
  • No changes to AGENTS.md or runtime/CI code

Copilot AI review requested due to automatic review settings July 10, 2026 17:01
@batmnnn batmnnn force-pushed the docs/enrich-contributing-and-templates branch 2 times, most recently from 6657cc1 to b7831e1 Compare July 10, 2026 17:02
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
@batmnnn batmnnn force-pushed the docs/enrich-contributing-and-templates branch from b7831e1 to 3ff333a Compare July 10, 2026 17:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 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.md with contribution paths, a lightweight claim-an-issue flow, and pointers to AGENTS.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.

Comment thread .github/pull_request_template.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@batmnnn

batmnnn commented Jul 10, 2026

Copy link
Copy Markdown
Author

@illegalcall Hi Dhruv, pinging you for the review.

@illegalcall illegalcall left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md

Small 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.

@batmnnn

batmnnn commented Jul 10, 2026

Copy link
Copy Markdown
Author

@illegalcall cool pushing in a few minutes.

@batmnnn batmnnn requested a review from illegalcall July 10, 2026 21:09
@Vaibhaav-Tiwari

Copy link
Copy Markdown
Collaborator

hey
i still did not get the feel of beginner-friendly from the md, let's have a call and discuss it over it

@batmnnn

batmnnn commented Jul 12, 2026

Copy link
Copy Markdown
Author

cool let's do connect

meanwhile mentioning my thought process over this :

  1. Not keeping the contributing.md file an obvious.(not assuming the person on the other side knows it all)
  2. Giving out signals or points to the other party where they can go through and work on or ask guidance.(the table mentions this)
  3. This is just an extension to the current just a bit more detailed over things/signals.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: enrich CONTRIBUTING.md and add GitHub issue/PR templates

4 participants