summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJob van der Voort <job@gitlab.com>2017-03-17 11:43:33 +0000
committerJob van der Voort <job@gitlab.com>2017-03-17 11:43:33 +0000
commit5ae6d1f8568cf87637ee9d55c77efa76a765118d (patch)
tree6b577cb98e6a8cf8778ac0a8efaf1715153b866c
parent2f145352713009b60c60161e09be5b5bed2d87f4 (diff)
parent8d8dfd8e0d3c7b9eaca590fc742f5bcfc04133ac (diff)
downloadgitlab-ce-5ae6d1f8568cf87637ee9d55c77efa76a765118d.tar.gz
Add a documentation blurb to the new issue template to encourage writing (better) documentation.
-rw-r--r--.gitlab/issue_templates/Feature Proposal.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/.gitlab/issue_templates/Feature Proposal.md b/.gitlab/issue_templates/Feature Proposal.md
index ea895ee6275..2636010e2fb 100644
--- a/.gitlab/issue_templates/Feature Proposal.md
+++ b/.gitlab/issue_templates/Feature Proposal.md
@@ -5,3 +5,13 @@
### Proposal
### Links / references
+
+### Documentation blurb
+
+(Write the start of the documentation of this feature here, include:
+
+1. Why should someone use it; what's the underlying problem.
+2. What is the solution.
+3. How does someone use this
+
+During implementation, this can then be copied and used as a starter for the documentation.)