Link the changelog and the stability policy instead of copying them - #88
Merged
Conversation
The README carried a four-row table of every release from 0.4.0 on, which is the changelog restated in a place that cannot be kept in step with it, and a status blockquote whose first three sentences were the same sentences the Stability section repeats sixteen lines further down. Both are facts another file owns. The Roadmap is now the two labels the standard allows, and points at CHANGELOG.md for what each release contained. The status blockquote keeps the one thing in it that was neither policy nor history: that 1.0 does not mean every engine runs every model, and which model it is that ExecuTorch lowers and then fails to execute.
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 sections of the README were carrying facts that another file owns.
The Roadmap was a four-row table naming every release from
0.4.0on and whatlanded in each. That is
CHANGELOG.md, rewritten in a place with no mechanismto keep the two in step, and it grew by a row every release. It is now the two
labels the standard allows,
Shipped (1.0.0)andNext, a paragraph each,ending in the board and the milestones as before.
The status blockquote had the same problem and was worse about it: its opening
three sentences were the same claim about the four compatibility surfaces and
the two-minor deprecation window that the Stability section repeats sixteen
lines below, and it closed by restating that the bindings are unpublished,
which Installation and the architecture table already say. Sixteen lines down
to five.
What survived the cut is the part that was neither policy nor release history:
1.0does not mean every engine runs every model, and the suite recordsExecuTorch lowering VoltaCast and then failing to execute it as a failing
expectation rather than hiding it. A reader deciding whether to adopt this
needs that sentence and does not need to be told what shipped in
0.5.0.No content moved out of the repository. Every fact removed here is still in the
file that owns it.