From 0564f033fcb63b5ddf1fa51a159bb4569ef6f7f3 Mon Sep 17 00:00:00 2001
From: Nicolas Coden <nicolas@ncoden.fr>
Date: Tue, 21 Aug 2018 00:49:52 +0200
Subject: [PATCH] chore: simplify GitHub issue templates

---
 .github/ISSUE_TEMPLATE.md                   | 108 +++++++++++++-------
 .github/ISSUE_TEMPLATE/1-bug-report.md      |  92 +++++++++++------
 .github/ISSUE_TEMPLATE/2-feature-request.md |  88 ++++++++++------
 .github/ISSUE_TEMPLATE/3-documentation.md   |  51 +++++----
 .github/ISSUE_TEMPLATE/4-maintainance.md    |  47 +++++----
 5 files changed, 246 insertions(+), 140 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 157cc330b..f4f8d68d6 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,59 +1,91 @@
-<!--- --------------------------------------------------------------------- -->
-<!---                 Please fill the following template                    -->
-<!---                 Your issue may be ignored otherwise                   -->
-<!--- --------------------------------------------------------------------- -->
-<!---  Only submit bug or feature requests here. For help or questions to   -->
-<!---  the community, see the forum: https://foundation.zurb.com/forum      -->
+<!------------------------------------------------------------------------------
+│                  Please fill the following template.
+│           For more information, see the CONTRIBUTING.md document
+│            
+│       ⚠ Only submit bug or feature requests here. For help or questions
+│       to the community, see the forum: https://foundation.zurb.com/forum
+└------------------------------------------------------------------------------>
 
 ## Expected Behavior
-<!--- If describing a bug, tell us what should happen.                      -->
-<!--- If suggesting a change/feature, tell us why and how it should work.   -->
+<!-------------------------------------------------------------------
+│   If describing a bug, tell us what should happen.
+│   If suggesting a change/feature, tell us how it should
+│   work / how you would use the feature.
+└------------------------------------------------------------------->
+
+...
+
 
 ## Current Behavior
-<!--- If describing a bug, tell us what happens instead.                    -->
-<!--- If suggesting a change/feature, explain the difference from           -->
-<!--- current behavior.                                                     -->
+<!-------------------------------------------------------------------
+│   If describing a bug, tell us what happens instead.
+│   If suggesting a change/feature, tell us what's wrong
+│   or annoying in the current behavior.
+└------------------------------------------------------------------->
+
+...
+
 
 ## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug,                 -->
-<!--- or ideas how to implement the addition or change.                     -->
+<!-------------------------------------------------------------------
+│   [Optional] You can suggest a fix/reason for the bug,
+│   or ideas how to implement the addition or change.
+└------------------------------------------------------------------->
+
+...
+
 
 ## Test Case and/or Steps to Reproduce (for bugs)
-<!--- We highly recommend you to provide a live example of your bug so we   -->
-<!--- can reproduce it. You can create a test case with the last Foundation -->
-<!--- version by forking https://codepen.io/ncoden/pen/YLzjeq               -->
+<!-------------------------------------------------------------------
+│   We highly recommend you to provide a live example of your bug so we
+│   can reproduce it. You can create a test case with the last Foundation
+│   version by forking https://codepen.io/ncoden/pen/YLzjeq
+└------------------------------------------------------------------->
 Test Case: <!-- https://... -->
 
-<!--- If you cannot provide a test case, provide an unambiguous set of      -->
-<!--- steps to reproduce, with your code and configuration.                 -->
+<!-------------------------------------------------------------------
+│   If you cannot provide a test case, provide an unambiguous set
+│   of steps to reproduce, with your code and configuration.
+└------------------------------------------------------------------->
 How to reproduce:
 1.
 2.
 3.
 
+
 ## Context
-<!--- How has this issue affected you? What are you trying to accomplish?   -->
-<!--- Providing context helps us come up with a solution that is most       -->
-<!--- useful in the real world                                              -->
+<!-------------------------------------------------------------------
+│   [Optional] How has this issue affected you? What are you trying
+│   to accomplish? Providing context helps us come up with a solution
+│   that is most useful in the real world.
+└------------------------------------------------------------------->
+
+...
+
 
 ## Your Environment
-<!--- Include as many relevant details about the context and environment    -->
-<!--- you experienced the bug in. You can also provide logs.                -->
-- Foundation version(s) used:
-- Browser(s) name and version(s):
-- Operating System and version (desktop or mobile):
-- Link to your project:
-
-## Checklist (all required):
-<!--- Go over all the following points, and put an `x` in the boxes.        -->
-<!--- If you're unsure about any of these, don't hesitate to ask.           -->
-- [ ] I have read and follow the [CONTRIBUTING](CONTRIBUTING.md) document.
+<!-------------------------------------------------------------------
+│   Include as many relevant details about the context and environment
+│   you experienced the bug in. You can also provide logs.
+└------------------------------------------------------------------->
+- Foundation version(s) used: 
+- Browser(s) name and version(s): 
+- Device, Operating System and version: 
+- Link to your project: 
+
+
+## Checklist
+<!-------------------------------------------------------------------
+│   Please ensure that all the following points are respected.
+│   Fill with [x] the boxes once the rule is respected.
+└------------------------------------------------------------------->
+- [ ] I have read and follow the CONTRIBUTING.md document.
 - [ ] This is a bug report or a feature request.
 - [ ] There are no other issues similar to this one.
-- [ ] The issue title is descriptive.
-- [ ] The template is fully and correctly filled.
+- [ ] The issue title and template are correctly filled.
+
 
-<!--- --------------------------------------------------------------------- -->
-<!---       For more information, see the CONTRIBUTING.md document          -->
-<!---            Thank you for your issue and happy coding ;)               -->
-<!--- --------------------------------------------------------------------- -->
+<!------------------------------------------------------------------------------
+            For more information, see the CONTRIBUTING.md document
+              Thank you for your pull request and happy coding ;)
+------------------------------------------------------------------------------->
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md
index 615eaff36..987fbcee7 100644
--- a/.github/ISSUE_TEMPLATE/1-bug-report.md
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.md
@@ -4,57 +4,83 @@ about: Something is broken or doesn't work as expected
 
 ---
 
-<!--- --------------------------------------------------------------------- -->
-<!---                 Please fill the following template                    -->
-<!---                 Your issue may be ignored otherwise                   -->
-<!--- --------------------------------------------------------------------- -->
-<!---  Only submit bug reports here. For help or questions to the community -->
-<!---  see the forum: https://foundation.zurb.com/forum                     -->
+<!------------------------------------------------------------------------------
+│                  Please fill the following template.
+│           For more information, see the CONTRIBUTING.md document
+│            
+│       ⚠ Only submit bug reports here. For help or questions to the
+│       community, see the forum: https://foundation.zurb.com/forum
+└------------------------------------------------------------------------------>
 
 ## What should happen?
 
+...
+
 
 ## What happens instead?
 
+...
+
 
 ## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug,                 -->
-<!--- or ideas how to implement the addition or change.                     -->
+<!-------------------------------------------------------------------
+│   [Optional] You can suggest a fix/reason for the bug,
+│   or ideas how to implement the addition or change.
+└------------------------------------------------------------------->
+
+...
 
-## Test Case and/or Steps to Reproduce
-<!--- We highly recommend you to provide a live example of your bug so we   -->
-<!--- can reproduce it. You can create a test case with the last Foundation -->
-<!--- version by forking https://codepen.io/ncoden/pen/YLzjeq               -->
-Test Case:
 
-<!--- If you cannot provide a test case, provide an unambiguous set of      -->
-<!--- steps to reproduce, with your code and configuration.                 -->
+## Test Case and/or Steps to Reproduce (for bugs)
+<!-------------------------------------------------------------------
+│   We highly recommend you to provide a live example of your bug so we
+│   can reproduce it. You can create a test case with the last Foundation
+│   version by forking https://codepen.io/ncoden/pen/YLzjeq
+└------------------------------------------------------------------->
+Test Case: <!-- https://... -->
+
+<!-------------------------------------------------------------------
+│   If you cannot provide a test case, provide an unambiguous set
+│   of steps to reproduce, with your code and configuration.
+└------------------------------------------------------------------->
 How to reproduce:
 1.
 2.
 3.
 
+
 ## Context
-<!--- How has this issue affected you? What are you trying to accomplish?   -->
-<!--- Providing context helps us come up with a solution that is most       -->
-<!--- useful in the real world                                              -->
+<!-------------------------------------------------------------------
+│   [Optional] How has this issue affected you? What are you trying
+│   to accomplish? Providing context helps us come up with a solution
+│   that is most useful in the real world.
+└------------------------------------------------------------------->
+
+...
+
 
 ## Your Environment
-<!--- Include as many relevant details about the context and environment    -->
-<!--- you experienced the bug in. You can also provide logs if relevant.    -->
-- Foundation version(s) used:
-- Browser(s) name and version(s):
-- Operating System and version (desktop or mobile):
-
-## Checklist (all required):
-<!--- Go over all the following points, and put an `x` in the boxes.        -->
-<!--- If you're unsure about any of these, don't hesitate to ask.           -->
+<!-------------------------------------------------------------------
+│   Include as many relevant details about the context and environment
+│   you experienced the bug in. You can also provide logs.
+└------------------------------------------------------------------->
+- Foundation version(s) used: 
+- Browser(s) name and version(s): 
+- Device, Operating System and version: 
+- Link to your project: 
+
+
+## Checklist
+<!-------------------------------------------------------------------
+│   Please ensure that all the following points are respected.
+│   Fill with [x] the boxes once the rule is respected.
+└------------------------------------------------------------------->
 - [ ] I have read and follow the CONTRIBUTING.md document.
 - [ ] There are no other issues similar to this one.
-- [ ] The issue title is descriptive.
-- [ ] The template is correctly filled.
+- [ ] The issue title and template are correctly filled.
+
 
-<!--- --------------------------------------------------------------------- -->
-<!---       For more information, see the CONTRIBUTING.md document          -->
-<!---            Thank you for your issue and happy coding ;)               -->
-<!--- --------------------------------------------------------------------- -->
+<!------------------------------------------------------------------------------
+            For more information, see the CONTRIBUTING.md document
+              Thank you for your pull request and happy coding ;)
+------------------------------------------------------------------------------->
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md
index 3c2c798f1..28b28ce21 100644
--- a/.github/ISSUE_TEMPLATE/2-feature-request.md
+++ b/.github/ISSUE_TEMPLATE/2-feature-request.md
@@ -4,45 +4,69 @@ about: Something is missing or could be improved
 
 ---
 
-<!--- --------------------------------------------------------------------- -->
-<!---                 Please fill the following template                    -->
-<!---                 Your issue may be ignored otherwise                   -->
-<!--- --------------------------------------------------------------------- -->
-<!---  Only submit feature requests here. For help or questions to the      -->
-<!---  community, see the forum: https://foundation.zurb.com/forum          -->
+<!------------------------------------------------------------------------------
+│                  Please fill the following template.
+│           For more information, see the CONTRIBUTING.md document
+│            
+│       ⚠ Only submit feature requests here. For help or questions to
+│       the community, see the forum: https://foundation.zurb.com/forum
+└------------------------------------------------------------------------------>
 
 ## What is missing?
-<!--- What you want to be added or improved and how you would use it?       -->
+<!-------------------------------------------------------------------
+│   How the feature should work / how you would use it ?
+└------------------------------------------------------------------->
+
+...
+
+
+## What is wrong now ?
+<!-------------------------------------------------------------------
+|   What are the current workarounds and how are they insufficient ?
+└------------------------------------------------------------------->
+
+...
 
-## Why is it important?
-<!--- Why would this feature benefit everyone? What is the current          -->
-<!--- workaround and how is it insufficient or inadequate?                  -->
 
 ## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug,                 -->
-<!--- or ideas how to implement the addition or change.                     -->
+<!-------------------------------------------------------------------
+│   [Optional] You can suggest ideas how to implement the feature.
+└------------------------------------------------------------------->
+
+...
+
 
 ## Context
-<!--- How has this issue affected you? What are you trying to accomplish?   -->
-<!--- Providing context helps us come up with a solution that is most       -->
-<!--- useful in the real world                                              -->
+<!-------------------------------------------------------------------
+│   [Optional] How has this issue affected you? What are you trying
+│   to accomplish? Providing context helps us come up with a solution
+│   that is most useful in the real world.
+└------------------------------------------------------------------->
+
+...
+
 
 ## Your Environment
-<!--- Include as many relevant details about the context and environment    -->
-<!--- you're using. You can also provide logs if relevant.                  -->
-- Foundation version(s) used:
-- Browser(s) name and version(s):
-- Operating System and version (desktop or mobile):
-
-## Checklist (all required):
-<!--- Go over all the following points, and put an `x` in the boxes.        -->
-<!--- If you're unsure about any of these, don't hesitate to ask.           -->
+<!-------------------------------------------------------------------
+│   Include as many relevant details about the context and environment
+│   you are using. You can also provide logs if relevant.
+└------------------------------------------------------------------->
+- Foundation version(s) used: 
+- Browser(s) name and version(s): 
+- Device, Operating System and version: 
+
+
+## Checklist
+<!-------------------------------------------------------------------
+│   Please ensure that all the following points are respected.
+│   Fill with [x] the boxes once the rule is respected.
+└------------------------------------------------------------------->
 - [ ] I have read and follow the CONTRIBUTING.md document.
-- [ ] There are no other issues similar to this one.
-- [ ] The issue title is descriptive.
-- [ ] The template is correctly filled.
-
-<!--- --------------------------------------------------------------------- -->
-<!---       For more information, see the CONTRIBUTING.md document          -->
-<!---            Thank you for your issue and happy coding ;)               -->
-<!--- --------------------------------------------------------------------- -->
+- [ ] here are no other issues similar to this one.
+- [ ] The issue title and template are correctly filled.
+
+
+<!------------------------------------------------------------------------------
+            For more information, see the CONTRIBUTING.md document
+              Thank you for your pull request and happy coding ;)
+------------------------------------------------------------------------------->
diff --git a/.github/ISSUE_TEMPLATE/3-documentation.md b/.github/ISSUE_TEMPLATE/3-documentation.md
index 8b2b2f0c1..a56660af8 100644
--- a/.github/ISSUE_TEMPLATE/3-documentation.md
+++ b/.github/ISSUE_TEMPLATE/3-documentation.md
@@ -4,28 +4,41 @@ about: Typo mistakes, gaps or inconsistencies in docs or website
 
 ---
 
-<!--- --------------------------------------------------------------------- -->
-<!---                 Please fill the following template                    -->
-<!---                 Your issue may be ignored otherwise                   -->
-<!--- --------------------------------------------------------------------- -->
-<!---  Only submit documentation issue here. For help or questions to the.  -->
-<!---  community, see the forum: https://foundation.zurb.com/forum          -->
+<!------------------------------------------------------------------------------
+│                  Please fill the following template.
+│           For more information, see the CONTRIBUTING.md document
+│            
+│       ⚠ Only submit documentation issues here. For help or questions to
+│       the community, see the forum: https://foundation.zurb.com/forum
+└------------------------------------------------------------------------------>
 
 ## Description
-<!--- What is incorrect, missing or could be improved?                      -->
+<!-------------------------------------------------------------------
+│   What is incorrect, missing or could be improved?
+└------------------------------------------------------------------->
+
+...
+
 
 ## Possible Solution
-<!--- How would you resolve that?                                           -->
+<!-------------------------------------------------------------------
+│   What do you suggest to resolve this issue?
+└------------------------------------------------------------------->
+
+...
 
-## Checklist (all required):
-<!--- Go over all the following points, and put an `x` in the boxes.        -->
-<!--- If you're unsure about any of these, don't hesitate to ask.           -->
+
+## Checklist
+<!-------------------------------------------------------------------
+│   Please ensure that all the following points are respected.
+│   Fill with [x] the boxes once the rule is respected.
+└------------------------------------------------------------------->
 - [ ] I have read and follow the CONTRIBUTING.md document.
-- [ ] There are no other issues similar to this one.
-- [ ] The issue title is descriptive.
-- [ ] The template is correctly filled.
-
-<!--- --------------------------------------------------------------------- -->
-<!---       For more information, see the CONTRIBUTING.md document          -->
-<!---            Thank you for your issue and happy coding ;)               -->
-<!--- --------------------------------------------------------------------- -->
+- [ ] here are no other issues similar to this one.
+- [ ] The issue title and template are correctly filled.
+
+
+<!------------------------------------------------------------------------------
+            For more information, see the CONTRIBUTING.md document
+              Thank you for your pull request and happy coding ;)
+------------------------------------------------------------------------------->
diff --git a/.github/ISSUE_TEMPLATE/4-maintainance.md b/.github/ISSUE_TEMPLATE/4-maintainance.md
index 1f8b33eed..26bce5d1e 100644
--- a/.github/ISSUE_TEMPLATE/4-maintainance.md
+++ b/.github/ISSUE_TEMPLATE/4-maintainance.md
@@ -4,27 +4,38 @@ about: Tests, dependencies, workflow...
 
 ---
 
-<!--- --------------------------------------------------------------------- -->
-<!---                 Please fill the following template                    -->
-<!---                 Your issue may be ignored otherwise                   -->
-<!--- --------------------------------------------------------------------- -->
-<!---  Only submit maintainance issues here. For help or questions to the.  -->
-<!---  community, see the forum: https://foundation.zurb.com/forum          -->
+<!------------------------------------------------------------------------------
+│                  Please fill the following template.
+│           For more information, see the CONTRIBUTING.md document
+│            
+│       ⚠ Only submit maintainance issues here. For help or questions to
+│       the community, see the forum: https://foundation.zurb.com/forum
+└------------------------------------------------------------------------------>
 
 ## Description
 
+...
+
+
 ## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason to resolve the issue.        -->
+<!-------------------------------------------------------------------
+│   What do you suggest to resolve this issue?
+└------------------------------------------------------------------->
+
+...
 
-## Checklist (all required):
-<!--- Go over all the following points, and put an `x` in the boxes.        -->
-<!--- If you're unsure about any of these, don't hesitate to ask.           -->
+
+## Checklist
+<!-------------------------------------------------------------------
+│   Please ensure that all the following points are respected.
+│   Fill with [x] the boxes once the rule is respected.
+└------------------------------------------------------------------->
 - [ ] I have read and follow the CONTRIBUTING.md document.
-- [ ] There are no other issues similar to this one.
-- [ ] The issue title is descriptive.
-- [ ] The template is correctly filled.
-
-<!--- --------------------------------------------------------------------- -->
-<!---       For more information, see the CONTRIBUTING.md document          -->
-<!---            Thank you for your issue and happy coding ;)               -->
-<!--- --------------------------------------------------------------------- -->
+- [ ] here are no other issues similar to this one.
+- [ ] The issue title and template are correctly filled.
+
+
+<!------------------------------------------------------------------------------
+            For more information, see the CONTRIBUTING.md document
+              Thank you for your pull request and happy coding ;)
+------------------------------------------------------------------------------->
-- 
2.47.2