docs: describe the changelog output as Keep a Changelog - #17
Merged
Conversation
The output follows Keep a Changelog: section names and their order. Attributing it to a downstream project that also follows that format described the target indirectly, and read as if the format were that project's invention. The bullet shaping (per-crate headings, backticked identifiers, brace-grouped type members, impl grouping) is zc's own and is now documented as such rather than attributed.
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.
The
--changelogoutput follows Keep a Changelog:section names and their order. Describing it as another project's style named the
format indirectly, and read as if the format were that project's invention.
The bullet shaping — per-crate headings, backticked identifiers, brace-grouped type
members,
impl Trait for Selfgrouping — is not part of Keep a Changelog, so it is nowdocumented as zc's own rather than attributed.
Also keeps the curation rules (what deserves an entry, which release it describes, which
commit it belongs in) but states them directly: Keep a Changelog fixes the sections, not
which changes deserve a bullet.
Docs, help text and test comments only; no behaviour change. Integration suite 118 passed,
0 failed; unit tests 30 passed.