about summary refs log tree commit diff
path: root/ABSEIL_ISSUE_TEMPLATE.md
diff options
context:
space:
mode:
authormisterg <misterg@google.com>2017-09-19T20·54-0400
committermisterg <misterg@google.com>2017-09-19T20·54-0400
commitc2e754829628d1e9b7a16b3389cfdace76950fdf (patch)
tree5a7f056f44e27c30e10025113b644f0b3b5801fc /ABSEIL_ISSUE_TEMPLATE.md
Initial Commit
Diffstat (limited to 'ABSEIL_ISSUE_TEMPLATE.md')
-rw-r--r--ABSEIL_ISSUE_TEMPLATE.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/ABSEIL_ISSUE_TEMPLATE.md b/ABSEIL_ISSUE_TEMPLATE.md
new file mode 100644
index 000000000000..585cdc3393eb
--- /dev/null
+++ b/ABSEIL_ISSUE_TEMPLATE.md
@@ -0,0 +1,22 @@
+Please submit a new Abseil Issue using the tempate below:
+
+## [Short title of proposed API change(s)]
+
+--------------------------------------------------------------------------------
+--------------------------------------------------------------------------------
+
+## Background
+
+[Provide the background information that is required in order to evaluate the
+proposed API changes. No controversial claims should be made here. If there are
+design constraints that need to be considered, they should be presented here
+**along with justification for those constraints**. Linking to other docs is
+good, but please keep the **pertinent information as self contained** as
+possible in this section.]
+
+## Proposed API Change (s)
+
+[Please clearly describe the API change(s) being proposed. If multiple changes,
+please keep them clearly distinguished. When possible, **use example code
+snippets to illustrate before–after API usages**. List pros-n-cons. Highlight
+the main questions that you want to be answered.Given the Abseil project compatibility requirements, describe why the API change is safe."]