feat(AIP-8) rm appendix, add rationale and history #1058
Merged
Conversation
This file contains 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
As discussed in aip-dev#1048, appendix is a bit of a misnomer as a place to put design discussions, and there's a clear need based on internal conversations for consumers of AIPs to understand *why* a change was made. Adding two sections which can provide parts of the story: - rationale introduces a section to explain current design decisions. - history introduces a section to give historical context as needed (e.g. if a major change happens to an AIP).
|
@jskeet who I saw had some vehement nods in the meeting today, so likely opinionated enough to review this :) (if you have time) |
Note to self: show no emotion, do not react 😛 |
- more clarity around history vs changelog
shwoodard
requested changes
Apr 3, 2023
- fixing some wording. - consistent line length on all changes.
shwoodard
approved these changes
Apr 7, 2023
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.
As discussed in #1048, appendix is a bit of a misnomer as a place to put design discussions, and there's a clear need based on internal conversations for consumers of AIPs to understand why a change was made.
Adding two sections which can provide parts of the story: