From 52f2fc92e5294bcd508cff0b80b54cfe09ea3773 Mon Sep 17 00:00:00 2001 From: Andrew Rynhard Date: Sun, 28 Apr 2019 15:53:22 -0700 Subject: [PATCH] chore: add proposals template (#590) Signed-off-by: Andrew Rynhard --- docs/proposals/YYYYMMDD-TEMPLATE.md | 34 +++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/proposals/YYYYMMDD-TEMPLATE.md diff --git a/docs/proposals/YYYYMMDD-TEMPLATE.md b/docs/proposals/YYYYMMDD-TEMPLATE.md new file mode 100644 index 000000000..52f71cb19 --- /dev/null +++ b/docs/proposals/YYYYMMDD-TEMPLATE.md @@ -0,0 +1,34 @@ +# Proposal: [Title] + +Author(s): [Author Name, Co-Author Name] + +Last updated: [Date] + +## 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.]