contributing: say what gets declined, and how to cut a release - #12
Merged
Conversation
CONTRIBUTING.md, issue templates for bugs and features, and docs/releasing.md. The commit and testing sections defer to CLAUDE.md rather than restating it, and docs/releasing.md describes the branch-and-PR flow a release actually goes through, so the three documents cannot drift apart.
Merged
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
1 participant
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.
An outside patch can be well written and still unmergeable here, and it is fairer to say
so before someone writes it.
CONTRIBUTING.md— what will be declined and why it is not a preference to be arguedout of: a dependency, capturing the mouse,
unsafeoutside the backends, a platform#[cfg]abovesrc/sys/,println!for UI, a file over 500 lines. Then what is welcome,the pre-flight commands, and a Windows section that asks for reports from real hardware
and repeats the rule that no Windows behaviour is claimed unless a command printed it.
Issue templates — a bug form that asks for the terminal, the OS and a file that
reproduces, and a feature form that asks which of the non-negotiables the idea needs.
docs/releasing.md— the tag is the release, so the doc is mostly the order thatavoids re-doing it: the version lives in three places (and the README copy is the one that
gets forgotten), the bump goes through a branch and a PR,
ci.ymlmust be green on themerge commit and not just the branch,
-mis mandatory becausetag.gpgsignis on, andhow to move a tag when the run fails — with the line between that and the
never-rewrite-published-history rule spelled out.
README.md's Docs section now points at both.Kept aligned with
CLAUDE.mdrather than duplicating it: the Commits section statesthe same
scope: imperative descriptionrule and namesCLAUDE.md§ Commits andhistory as the version that wins; the testing paragraph hands off to § Build, run,
test for the corpus checks and soak harnesses. The cross-check list matches
ci.yml.Docs and templates only; no code touched.
cargo testgreen (1308 + the integrationbinaries, 0 failed).
Pairs with #11. Either can merge first — they touch disjoint files and neither depends on
the other existing.