aboutsummaryrefslogtreecommitdiff
path: root/design
diff options
context:
space:
mode:
authorAndrew Gerrand <adg@golang.org>2015-07-30 13:22:59 +1000
committerAndrew Gerrand <adg@golang.org>2015-07-30 05:31:51 +0000
commit01029b917fbbfcf1cbf53df42c8c3f48da9ffe7d (patch)
tree7add1d1b82c23d253eed3875157b925fb09cf56d /design
parentc3712b209d2c3887794f287051cb2935afa205d1 (diff)
downloadgo-x-proposal-01029b917fbbfcf1cbf53df42c8c3f48da9ffe7d.tar.xz
doc: add README.md and TEMPLATE.md
Change-Id: I8c303d27c096ee431eb72e5f04b58318b55cabce Reviewed-on: https://go-review.googlesource.com/12882 Reviewed-by: Russ Cox <rsc@golang.org> Reviewed-by: Rob Pike <r@golang.org>
Diffstat (limited to 'design')
-rw-r--r--design/TEMPLATE.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/design/TEMPLATE.md b/design/TEMPLATE.md
new file mode 100644
index 0000000..dab5567
--- /dev/null
+++ b/design/TEMPLATE.md
@@ -0,0 +1,35 @@
+[This is a template for Go's change proposal process, documented [here](../README.md).]
+
+# 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
+[compatibility guidelines](https://golang.org/doc/go1compat)
+and future maintainability.]
+
+## Implementation
+
+[A description of the steps in the implementation, who will do them, and when.
+This should include a discussion of how the work fits into [Go's release cycle](https://golang.org/wiki/Go-Release-Cycle).]
+