Skip to content

feat(AIP-8): add voice guidance #1131

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

Open
toumorokoshi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(AIP-8): add voice guidance #1131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions aip/general/0008.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ While the length of AIPs will necessarily vary based on the complexity of the
question, most AIPs **should** be able to cover their content in roughly two
printed pages.

## Voice

AIPs have a consistent voice to ensure clear, readable and succinct guidance.

- AIPs **must** not include ambiguous or unclear phrasing.
- AIPs **must** use active voice where possible.
- AIPs **must** not use [pleonastic][] words or phrases.

AIPs **should** format guidance in a bulleted list of statements. Exceptions
include:

- Where guidance does not fit succinctly in a bulleted list.
- Where elaboration is necessary such that a paragraph is more suitable.

### File structure

AIPs **must** be written in Markdown, and **must** be named using their
Expand Down Expand Up @@ -194,6 +208,7 @@ branch.
[aip-1]: ./0001.md
[protocol buffers]: https://developers.google.com/protocol-buffers/
[rfc 2119]: https://www.ietf.org/rfc/rfc2119.txt
[pleonastic]: https://en.wikipedia.org/wiki/Pleonasm

## Changelog

Expand Down