docs: add CONTRIBUTING.md#42
Open
pbegg wants to merge 1 commit intoWoyken:mainfrom
Open
Conversation
Documents the fork-and-PR workflow, required local checks (ruff, ty), and the towncrier fragment convention for external contributors. References AGENTS.md as the source of truth for coding rules rather than duplicating them.
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
Adds a
CONTRIBUTING.mdat the repo root documenting the external-contributor workflow. There isn't one today, so the process is implicit and has to be inferred from the README's Development section and recent merged PRs. This draft makes it explicit.Raising the PR itself (rather than an issue) so you can react to concrete wording — feel free to request any changes, trim, or reject outright if you'd prefer not to have one.
What it covers
upstreamremote setup; syncingmainbefore branching.uvfor all Python commands (consistent withAGENTS.mdrule 3).ruff check,ruff format --check,ty check --python-version 3.14 --ignore unknown-argument.newsfragments/), filename format (<id-or-slug>.<type>.md), and types (feature,bugfix,doc,removal,misc).towncrier buildis maintainer-only.What it deliberately doesn't do
AGENTS.md— it references it as the source of truth.CONTRIBUTING.mdand a towncrier doc fragment.Things worth your call
.github/CONTRIBUTING.md— I went with root for discoverability.Test plan
newsfragments/contributing-guide.doc.mdfollowing existing convention