docs: define the 1.x compatibility policy for catalog, behavior, and output changes - #321
Merged
Merged
Conversation
…output changes Fixes #313
4 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.
Fixes #313
Summary
Records how catalog, parse/validation/emit, and API changes are versioned under 1.x, in
docs/compatibility-facades.md, and links it from the semver section ofdocs/release.md.Decisions (maintainer)
--generate-notes, i.e. merged PR titles. Catalog updates usefeat(catalog). Other changes to parse/validation/emit results usefeat(<area>)with a## Behavior changesection in the PR body.fixis kept for patch-level changes. No tooling change is needed, because release-plz already derives a minor release fromfeat.Review points
Program, emitted text, validation results, or catalog content is minor. Most pastfix(parser|emitter|catalog)PRs would befeatunder this rule.Verification
Documentation-only change; maintainer review is the completion check.
git diff --checkpasses, and the new anchor link fromrelease.mdmatches the heading.