docs: add CONTRIBUTING.md describing the issue-first workflow - #14
Merged
Merged
Conversation
Writes down how work is tracked here: every change starts as an issue, anything with a design question gets a Discussion cross-linked to that issue, a maintainer labels the issue `accepted` once it's agreed the work should happen, and the PR that does it links back with a closing keyword. Also covers the parts a contributor needs to act on that rule — what belongs in an issue, which changes can skip the discussion step (bugs and docs), the local build/vet/test commands CI mirrors, and why a docs-only PR goes green without building. Includes a warning against pasting real captures into public threads. Sessions and HAR exports are verbatim traffic — auth headers, cookies, and bodies — and a tool whose whole job is intercepting secrets should say so where contributors will see it. Note: the `accepted` label doesn't exist in the repo yet and needs creating for this to be true. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MavUrTwm29bQRDy2Nufoq3
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.
Writes down how work is tracked here: every change starts as an issue,
anything with a design question gets a Discussion cross-linked to that
issue, a maintainer labels the issue
acceptedonce it's agreed the workshould happen, and the PR that does it links back with a closing keyword.
Also covers the parts a contributor needs to act on that rule — what
belongs in an issue, which changes can skip the discussion step (bugs and
docs), the local build/vet/test commands CI mirrors, and why a docs-only
PR goes green without building.
Includes a warning against pasting real captures into public threads.
Sessions and HAR exports are verbatim traffic — auth headers, cookies,
and bodies — and a tool whose whole job is intercepting secrets should
say so where contributors will see it.
Note: the
acceptedlabel doesn't exist in the repo yet and needscreating for this to be true.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01MavUrTwm29bQRDy2Nufoq3