talos/docs/proposals/YYYYMMDD-TEMPLATE.md
Andrew Rynhard 8c73c38b8a chore: enforce one sentence per line in Markdown files
This is widely considered best practice, we should enforce it.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-08-17 10:15:27 -07:00

33 lines
773 B
Markdown

# Proposal: [Title]
Author(s): [Author Name, Co-Author Name]
## Abstract
[A short summary of the proposal.]
## Background
[An introduction of the necessary background and the problem being solved by the proposed change.]
## Proposal
[A precise statement of the proposed change.]
## Rationale
[A discussion of alternate approaches and the trade offs, advantages, and disadvantages of the specified approach.]
## Compatibility
[A discussion of the change with regard to the change]
## Implementation
[A description of the steps in the implementation, who will do them, and when.]
## Open issues (if applicable)
[A discussion of issues relating to this proposal for which the author does not know the solution.]
[This section may be omitted if there are none.]