Repository navigation
docs(contributing): issue-first flow with linked PRs and issue templates - #20
Merged
Merged
Conversation
Every change starts with an issue; the pull request is opened early against develop and linked with a closing keyword. The PR template now carries a required Closes line and checklist item. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Adds the three issue templates plus config.yml, which disables blank issues and routes security reports to the private policy. Supports the issue-first contribution flow. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
8 of 9 tasks
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
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
Make the issue-first contribution flow the default and document it: open an issue, open a linked pull request early, continue on the pull request.
Why
Closes #18. Today
CONTRIBUTING.mdonly asks for an issue "for a larger change" and nothing ties a pull request back to its issue. Issue-first with a linked PR gives every change a tracked rationale, lets reviewers follow work in progress, and keepsdevelophistory traceable.Changes
develop, open the pull request early (draft is fine), and link it withCloses #NNN. Security still routes throughSECURITY.md.Closes #line in Why and a matching checklist item make the linked issue explicit.bug_report,feature_requestandchoretemplates, plusconfig.ymlthat disables blank issues and points security reports to the private policy.Notes for reviewers
Checklist
Closes #18above)developand is about one thingdocs: ...,chore: ...)