docs: add a changelog and a pull request template - #17
Merged
Merged
Conversation
CHANGELOG.md is seeded from the v0.1.0 release notes and carries an Unreleased section with what has landed since. Its preamble states the one thing a changelog for this project has to state: anything that changes what a number means is called out under Changed rather than buried under Fixed, because a figure that moved for a methodology reason is a different event from one that moved because it was wrong. The pull request template is four lines and adds no checklist. It asks for the why, and for the two confirmations this project actually cares about: that a rendered figure carries its n and its null, and that a new vendor was config rather than a new module. It also says which checks gate a merge, so a contributor seeing an advisory failure knows what to do with it. PLAN.md records what was considered and declined, with the reason and the condition that would reopen it: .editorconfig, pre-commit, CODEOWNERS, CITATION.cff and PyPI publishing. CI caching was not added because setup-uv already runs with enable-cache. A file added because projects usually have one is a file that rots, and a decision with no recorded reason gets re-proposed as an oversight. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
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.
Two files added, five declined with reasons recorded.
CHANGELOG.md, seeded from the v0.1.0 release notes, with an Unreleased section for what has landed since. Its preamble states the rule that matters for this project: anything changing what a number means goes under Changed, not Fixed, because a figure that moved for a methodology reason is a different event from one that moved because it was wrong.
.github/pull_request_template.md, four lines, no checklist. It asks for the why and for the two confirmations this project cares about: a rendered figure carries its n and its null, and a new vendor was config rather than a new module.
Declined, recorded in docs/PLAN.md with the condition that would reopen each:
.editorconfig(ruff already owns formatting and nothing here reads an editorconfig, so it would be a second source of truth that can disagree), pre-commit (catches what CI catches, in exchange for a setup step and a second place lint versions live), CODEOWNERS (one maintainer), CITATION.cff (nobody has cited this), PyPI (commits to a name and cadence before the API settles).CI caching was already done —
setup-uvruns withenable-cache: true. Noted rather than re-added.