From 0ac9bf2bd1d8f1ae027ec6869fe9cf3df7a88d73 Mon Sep 17 00:00:00 2001 From: Job van der Voort Date: Wed, 21 Jun 2017 17:20:02 +0000 Subject: [PATCH] a new feature checklist and more elaborate documentation requirements --- .gitlab/issue_templates/Feature Proposal.md | 24 +++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/.gitlab/issue_templates/Feature Proposal.md b/.gitlab/issue_templates/Feature Proposal.md index 85ca1bca623..1278061a410 100644 --- a/.gitlab/issue_templates/Feature Proposal.md +++ b/.gitlab/issue_templates/Feature Proposal.md @@ -27,12 +27,24 @@ Please remove this notice if you're confident your issue isn't a duplicate. ### Documentation blurb -(Write the start of the documentation of this feature here, include: +#### Overview -1. Why should someone use it; what's the underlying problem. -2. What is the solution. -3. How does someone use this +What is it? +Why should someone use this feature? +What is the underlying (business) problem? +How do you use this feature? -During implementation, this can then be copied and used as a starter for the documentation.) +#### Use cases -/label ~"feature proposal" +Who is this for? Provide one or more use cases. + +### Feature checklist + +Make sure these are completed before closing the issue, +with a link to the relevant commit. + +- [ ] [Feature assurance](https://about.gitlab.com/handbook/product/#feature-assurance) +- [ ] Documentation +- [ ] Added to [features.yml](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/features.yml) + +/label ~"feature proposal" \ No newline at end of file