Tell contributors to check for duplicates and the right branch - #8609
Tell contributors to check for duplicates and the right branch#8609ParadokS81 wants to merge 2 commits into
Conversation
The skill sends contributors straight to filing without two steps that prevent wasted work: searching for an existing report, and confirming the bug against the branch development happens on. `master` is weeks behind a shipped release, so a bug verified there can be already fixed or simply not the code users run. Also aligns the test guidance with AGENTS.md, which asks for the focused suite rather than ./test/all. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates contributor guidance to reduce duplicate reports and verify bugs against current development code.
Changes:
- Adds issue and PR search guidance.
- Adds default-branch verification instructions.
- Clarifies focused test execution and environmental failures.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Confirm by stashing the change and re-running, then say what you ran in the | ||
| PR. |
| Check the bug against the branch development actually happens on, not against | ||
| whatever `git clone` or a raw URL hands you. `master` is not it, and can be | ||
| weeks behind a shipped release — so a bug "confirmed" there may already be | ||
| fixed, or the code may not match what users are running: |
…ctually comes from A plain git clone checks out the default branch; the stale-master trap is an older checkout or a raw URL pinned to master. And a bare git stash leaves new files in place, so the baseline rerun would still include the change.
|
Both notes addressed: the stash step now says |
|
Worth knowing before this gets reviewed: the guidance here is right, but
So for the PR-submission path, |
contributing.mdsends contributors straight from "found a bug" to filing. Two steps in between prevent wasted work on both sides, and I hit both writing #8597.Check for an existing report
Searching only issues misses open PRs. I found two bugs in
omarchy-font-set; one was already #6957 with PR #6958 open and a better fix than I would have written. Searching issues alone would not have surfaced it.Verify against the default branch
masteris not where development happens and can be weeks behind a shipped release:I fetched
bin/omarchy-font-setfrommasterto check whether a bug still existed and got a version older than my own installed copy — missing the fontconfig rewrite that had already shipped. A bug "confirmed" that way may already be fixed, or simply not be the code users run.The added section teaches the check (
gh repo view --json defaultBranchRef) rather than naming today's branch, so it stays correct when the branch changes.Test guidance
AGENTS.mdasks for "focused automated tests for the area you changed"; this file said to run./test/allbefore pushing, and callsAGENTS.mdthe authority. On my machine./test/allreports 6 failures on a clean tree — attached-monitor counts, a missing sibling checkout, a network-dependent check — none related to any change. Read as a gate, that blocks valid PRs. Aligned the wording withAGENTS.mdand noted how to tell an environmental failure from a real one.Docs only; no behaviour change.