Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(AIP-8) rm appendix, add rationale and history #1058

Merged
merged 5 commits into from
Apr 7, 2023
Merged

feat(AIP-8) rm appendix, add rationale and history #1058

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
47ec46b
feat(AIP-8) rm appendix, add rationale and history
toumorokoshi Mar 30, 2023
6c24276
addressing feedback
toumorokoshi Mar 31, 2023
85c501d
addressing feedback
toumorokoshi Apr 5, 2023
1ef6670
Merge branch 'master' into toum/appendix-to-rationale
toumorokoshi Apr 5, 2023
77fc069
Merge branch 'master' into toum/appendix-to-rationale
toumorokoshi Apr 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions aip/general/0008.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,18 +114,29 @@ followed by a bulleted list explaining the example.
Individual subsections can be cited individually, and further elaborate
details.

## Rationale

The "rationale" section is optional, and helps the reader understand the
motivation for specific guidance within the AIP.

Deeper explanations of design justification and tradeoffs **must** be in the
rationale instead of other sections, to ensure the rest of the document acts as
an easily digestible reference.

## History

The "history" section is optional, and documents events and context around
a significant edit (e.g. rewrite) of an AIP.

- The section **must not** be used to exhaustively enumerate all changes (this
is what the changelog provides).

## Further reading

A bulleted list of (usually) other AIPs, in the following format:

- [AIP-1](./0001.md): AIP purpose and guidelines

## Appendix

An appendix is appropriate when a non-trivial side discussion is necessary. It
may explain historical reasons for the guidance, alternatives considered, or
other issues potentially of interest to the reader.

## Changelog

A bulleted list of changes in reverse chronological order, using the following
Expand Down Expand Up @@ -182,5 +193,6 @@ branch.

## Changelog

- **2023-03-30**: Removed appendix, added rationale and history to the template.
- **2020-02-18**: Specified reverse chronological ordering for changelog items.
- **2019-08-23**: Added guidance for internal AIP links.
- **2019-08-23**: Added guidance for internal AIP links.