docs: add CONTRIBUTING.md and PR template to prevent duplicate PRs#35
Open
dmchaledev wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md and PR template to prevent duplicate PRs#35dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
The repo has repeatedly ended up with multiple open PRs independently implementing the same fix (see #34: 27 open PRs, ~9 duplicate or already superseded by main). Add a CONTRIBUTING.md that requires checking open issues/PRs before starting work, and a PR template with a pre-flight duplicate-check checklist item, to address the root cause identified in #34's suggested fix. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RSt4rSozqQYR1sRfyvdEcr
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This repo currently has a well-documented problem (#34): 27 open PRs, roughly 9 of which are duplicate or superseded implementations of the same fix, because contributors aren't checking existing open issues/PRs before starting work on the same files (
asm/openapi.yaml,sat/openapi.yaml,docs/index.html).This PR implements the recurrence-prevention step suggested in #34's "Suggested fix" item 4:
CONTRIBUTING.md— explains the duplicate-PR problem with a link to 27 open PRs contain ~9 duplicate/superseded submissions — needs triage before merging #34, and requires searching open issues/PRs before starting new work, with concreteghcommands to do so..github/pull_request_template.md— includes a pre-flight duplicate-check checklist item so the requirement is visible at PR-creation time, not just in a doc someone has to go find.CONTRIBUTING.mdfrom the README's new "Contributing" section.No functional/spec changes — this only affects the contribution workflow.
Test plan
CONTRIBUTING.mdrenders correctly (plain markdown, no special syntax)..github/pull_request_template.mdis picked up automatically by GitHub when opening a PR (standard.github/pull_request_template.mdpath).CONTRIBUTING.mdor PR template (checked all 27 open PR titles).🤖 Generated with Claude Code
Generated by Claude Code