]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
Use pull request #11466 from ncoden/chore/simplify-github-template for v6.5.0
authorNicolas Coden <nicolas@ncoden.fr>
Mon, 10 Sep 2018 20:50:33 +0000 (22:50 +0200)
committerNicolas Coden <nicolas@ncoden.fr>
Mon, 10 Sep 2018 20:50:33 +0000 (22:50 +0200)
9f639414f chore: simplify the GitHub pull request template
0564f033f chore: simplify GitHub issue templates

Signed-off-by: Nicolas Coden <nicolas@ncoden.fr>
.github/ISSUE_TEMPLATE.md
.github/ISSUE_TEMPLATE/1-bug-report.md
.github/ISSUE_TEMPLATE/2-feature-request.md
.github/ISSUE_TEMPLATE/3-documentation.md
.github/ISSUE_TEMPLATE/4-maintainance.md
.github/PULL_REQUEST_TEMPLATE.md

index 157cc330bf0caa627680b9f113176718f16c6595..f4f8d68d6bba445b1434eb30d8159f23356f473a 100644 (file)
@@ -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 ;)
+------------------------------------------------------------------------------->
index 615eaff361ada072bf48ba94e978ecedcc856d43..987fbcee7cf26a053a3b118973e00870854bc78b 100644 (file)
@@ -4,57 +4,83 @@ about: Something is broken or doesn't work as expected
 \r
 ---\r
 \r
-<!--- --------------------------------------------------------------------- -->\r
-<!---                 Please fill the following template                    -->\r
-<!---                 Your issue may be ignored otherwise                   -->\r
-<!--- --------------------------------------------------------------------- -->\r
-<!---  Only submit bug reports here. For help or questions to the community -->\r
-<!---  see the forum: https://foundation.zurb.com/forum                     -->\r
+<!------------------------------------------------------------------------------\r
+│                  Please fill the following template.\r
+│           For more information, see the CONTRIBUTING.md document\r
+│            \r
+│       ⚠ Only submit bug reports here. For help or questions to the\r
+│       community, see the forum: https://foundation.zurb.com/forum\r
+└------------------------------------------------------------------------------>\r
 \r
 ## What should happen?\r
 \r
+...\r
+\r
 \r
 ## What happens instead?\r
 \r
+...\r
+\r
 \r
 ## Possible Solution\r
-<!--- Not obligatory, but suggest a fix/reason for the bug,                 -->\r
-<!--- or ideas how to implement the addition or change.                     -->\r
+<!-------------------------------------------------------------------\r
+│   [Optional] You can suggest a fix/reason for the bug,\r
+│   or ideas how to implement the addition or change.\r
+└------------------------------------------------------------------->\r
+\r
+...\r
 \r
-## Test Case and/or Steps to Reproduce\r
-<!--- We highly recommend you to provide a live example of your bug so we   -->\r
-<!--- can reproduce it. You can create a test case with the last Foundation -->\r
-<!--- version by forking https://codepen.io/ncoden/pen/YLzjeq               -->\r
-Test Case:\r
 \r
-<!--- If you cannot provide a test case, provide an unambiguous set of      -->\r
-<!--- steps to reproduce, with your code and configuration.                 -->\r
+## Test Case and/or Steps to Reproduce (for bugs)\r
+<!-------------------------------------------------------------------\r
+│   We highly recommend you to provide a live example of your bug so we\r
+│   can reproduce it. You can create a test case with the last Foundation\r
+│   version by forking https://codepen.io/ncoden/pen/YLzjeq\r
+└------------------------------------------------------------------->\r
+Test Case: <!-- https://... -->\r
+\r
+<!-------------------------------------------------------------------\r
+│   If you cannot provide a test case, provide an unambiguous set\r
+│   of steps to reproduce, with your code and configuration.\r
+└------------------------------------------------------------------->\r
 How to reproduce:\r
 1.\r
 2.\r
 3.\r
 \r
+\r
 ## Context\r
-<!--- How has this issue affected you? What are you trying to accomplish?   -->\r
-<!--- Providing context helps us come up with a solution that is most       -->\r
-<!--- useful in the real world                                              -->\r
+<!-------------------------------------------------------------------\r
+│   [Optional] How has this issue affected you? What are you trying\r
+│   to accomplish? Providing context helps us come up with a solution\r
+│   that is most useful in the real world.\r
+└------------------------------------------------------------------->\r
+\r
+...\r
+\r
 \r
 ## Your Environment\r
-<!--- Include as many relevant details about the context and environment    -->\r
-<!--- you experienced the bug in. You can also provide logs if relevant.    -->\r
-- Foundation version(s) used:\r
-- Browser(s) name and version(s):\r
-- Operating System and version (desktop or mobile):\r
-\r
-## Checklist (all required):\r
-<!--- Go over all the following points, and put an `x` in the boxes.        -->\r
-<!--- If you're unsure about any of these, don't hesitate to ask.           -->\r
+<!-------------------------------------------------------------------\r
+│   Include as many relevant details about the context and environment\r
+│   you experienced the bug in. You can also provide logs.\r
+└------------------------------------------------------------------->\r
+- Foundation version(s) used: \r
+- Browser(s) name and version(s): \r
+- Device, Operating System and version: \r
+- Link to your project: \r
+\r
+\r
+## Checklist\r
+<!-------------------------------------------------------------------\r
+│   Please ensure that all the following points are respected.\r
+│   Fill with [x] the boxes once the rule is respected.\r
+└------------------------------------------------------------------->\r
 - [ ] I have read and follow the CONTRIBUTING.md document.\r
 - [ ] There are no other issues similar to this one.\r
-- [ ] The issue title is descriptive.\r
-- [ ] The template is correctly filled.\r
+- [ ] The issue title and template are correctly filled.\r
+\r
 \r
-<!--- --------------------------------------------------------------------- -->\r
-<!---       For more information, see the CONTRIBUTING.md document          -->\r
-<!---            Thank you for your issue and happy coding ;)               -->\r
-<!--- --------------------------------------------------------------------- -->\r
+<!------------------------------------------------------------------------------\r
+            For more information, see the CONTRIBUTING.md document\r
+              Thank you for your pull request and happy coding ;)\r
+------------------------------------------------------------------------------->\r
index 3c2c798f1f2d0d2fc667f4f67d5f7cd28374848e..28b28ce21f6a203103d276411a217b919d7f699a 100644 (file)
@@ -4,45 +4,69 @@ about: Something is missing or could be improved
 \r
 ---\r
 \r
-<!--- --------------------------------------------------------------------- -->\r
-<!---                 Please fill the following template                    -->\r
-<!---                 Your issue may be ignored otherwise                   -->\r
-<!--- --------------------------------------------------------------------- -->\r
-<!---  Only submit feature requests here. For help or questions to the      -->\r
-<!---  community, see the forum: https://foundation.zurb.com/forum          -->\r
+<!------------------------------------------------------------------------------\r
+│                  Please fill the following template.\r
+│           For more information, see the CONTRIBUTING.md document\r
+│            \r
+│       ⚠ Only submit feature requests here. For help or questions to\r
+│       the community, see the forum: https://foundation.zurb.com/forum\r
+└------------------------------------------------------------------------------>\r
 \r
 ## What is missing?\r
-<!--- What you want to be added or improved and how you would use it?       -->\r
+<!-------------------------------------------------------------------\r
+│   How the feature should work / how you would use it ?\r
+└------------------------------------------------------------------->\r
+\r
+...\r
+\r
+\r
+## What is wrong now ?\r
+<!-------------------------------------------------------------------\r
+|   What are the current workarounds and how are they insufficient ?\r
+└------------------------------------------------------------------->\r
+\r
+...\r
 \r
-## Why is it important?\r
-<!--- Why would this feature benefit everyone? What is the current          -->\r
-<!--- workaround and how is it insufficient or inadequate?                  -->\r
 \r
 ## Possible Solution\r
-<!--- Not obligatory, but suggest a fix/reason for the bug,                 -->\r
-<!--- or ideas how to implement the addition or change.                     -->\r
+<!-------------------------------------------------------------------\r
+│   [Optional] You can suggest ideas how to implement the feature.\r
+└------------------------------------------------------------------->\r
+\r
+...\r
+\r
 \r
 ## Context\r
-<!--- How has this issue affected you? What are you trying to accomplish?   -->\r
-<!--- Providing context helps us come up with a solution that is most       -->\r
-<!--- useful in the real world                                              -->\r
+<!-------------------------------------------------------------------\r
+│   [Optional] How has this issue affected you? What are you trying\r
+│   to accomplish? Providing context helps us come up with a solution\r
+│   that is most useful in the real world.\r
+└------------------------------------------------------------------->\r
+\r
+...\r
+\r
 \r
 ## Your Environment\r
-<!--- Include as many relevant details about the context and environment    -->\r
-<!--- you're using. You can also provide logs if relevant.                  -->\r
-- Foundation version(s) used:\r
-- Browser(s) name and version(s):\r
-- Operating System and version (desktop or mobile):\r
-\r
-## Checklist (all required):\r
-<!--- Go over all the following points, and put an `x` in the boxes.        -->\r
-<!--- If you're unsure about any of these, don't hesitate to ask.           -->\r
+<!-------------------------------------------------------------------\r
+│   Include as many relevant details about the context and environment\r
+│   you are using. You can also provide logs if relevant.\r
+└------------------------------------------------------------------->\r
+- Foundation version(s) used: \r
+- Browser(s) name and version(s): \r
+- Device, Operating System and version: \r
+\r
+\r
+## Checklist\r
+<!-------------------------------------------------------------------\r
+│   Please ensure that all the following points are respected.\r
+│   Fill with [x] the boxes once the rule is respected.\r
+└------------------------------------------------------------------->\r
 - [ ] I have read and follow the CONTRIBUTING.md document.\r
-- [ ] There are no other issues similar to this one.\r
-- [ ] The issue title is descriptive.\r
-- [ ] The template is correctly filled.\r
-\r
-<!--- --------------------------------------------------------------------- -->\r
-<!---       For more information, see the CONTRIBUTING.md document          -->\r
-<!---            Thank you for your issue and happy coding ;)               -->\r
-<!--- --------------------------------------------------------------------- -->\r
+- [ ] here are no other issues similar to this one.\r
+- [ ] The issue title and template are correctly filled.\r
+\r
+\r
+<!------------------------------------------------------------------------------\r
+            For more information, see the CONTRIBUTING.md document\r
+              Thank you for your pull request and happy coding ;)\r
+------------------------------------------------------------------------------->\r
index 8b2b2f0c16326f0538f1b2ec0c6c5f6ed853587b..a56660af8b5507170e767bda8dc53618fac41c9e 100644 (file)
@@ -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 ;)
+------------------------------------------------------------------------------->
index 1f8b33eed4c2b94f52cc8e2d1754c9cb6edfa296..26bce5d1e6e7180218c6bf50dab842b8a1ed256b 100644 (file)
@@ -4,27 +4,38 @@ about: Tests, dependencies, workflow...
 \r
 ---\r
 \r
-<!--- --------------------------------------------------------------------- -->\r
-<!---                 Please fill the following template                    -->\r
-<!---                 Your issue may be ignored otherwise                   -->\r
-<!--- --------------------------------------------------------------------- -->\r
-<!---  Only submit maintainance issues here. For help or questions to the.  -->\r
-<!---  community, see the forum: https://foundation.zurb.com/forum          -->\r
+<!------------------------------------------------------------------------------\r
+│                  Please fill the following template.\r
+│           For more information, see the CONTRIBUTING.md document\r
+│            \r
+│       ⚠ Only submit maintainance issues here. For help or questions to\r
+│       the community, see the forum: https://foundation.zurb.com/forum\r
+└------------------------------------------------------------------------------>\r
 \r
 ## Description\r
 \r
+...\r
+\r
+\r
 ## Possible Solution\r
-<!--- Not obligatory, but suggest a fix/reason to resolve the issue.        -->\r
+<!-------------------------------------------------------------------\r
+│   What do you suggest to resolve this issue?\r
+└------------------------------------------------------------------->\r
+\r
+...\r
 \r
-## Checklist (all required):\r
-<!--- Go over all the following points, and put an `x` in the boxes.        -->\r
-<!--- If you're unsure about any of these, don't hesitate to ask.           -->\r
+\r
+## Checklist\r
+<!-------------------------------------------------------------------\r
+│   Please ensure that all the following points are respected.\r
+│   Fill with [x] the boxes once the rule is respected.\r
+└------------------------------------------------------------------->\r
 - [ ] I have read and follow the CONTRIBUTING.md document.\r
-- [ ] There are no other issues similar to this one.\r
-- [ ] The issue title is descriptive.\r
-- [ ] The template is correctly filled.\r
-\r
-<!--- --------------------------------------------------------------------- -->\r
-<!---       For more information, see the CONTRIBUTING.md document          -->\r
-<!---            Thank you for your issue and happy coding ;)               -->\r
-<!--- --------------------------------------------------------------------- -->\r
+- [ ] here are no other issues similar to this one.\r
+- [ ] The issue title and template are correctly filled.\r
+\r
+\r
+<!------------------------------------------------------------------------------\r
+            For more information, see the CONTRIBUTING.md document\r
+              Thank you for your pull request and happy coding ;)\r
+------------------------------------------------------------------------------->\r
index 11fe5c0179c6ee16503b8be928ad15411324fe9a..fcf295d80332caf59f5fdc99334384b55924b6c2 100644 (file)
@@ -1,48 +1,50 @@
-<!--- --------------------------------------------------------------------- -->
-<!---                 Please fill the following template                    -->
-<!---             Your pull request may be ignored otherwise                -->
-<!--- --------------------------------------------------------------------- -->
+<!------------------------------------------------------------------------------
+                    Please fill the following template.
+            For more information, see the CONTRIBUTING.md document
+------------------------------------------------------------------------------->
 
 ## Description
-<!--- Describe your changes in detail. Include any relevant information     -->
-<!--- (reasons, difficulties, links to web references, related issues...)   -->
+<!-------------------------------------------------------------------
+│   Describe your changes in detail. Include any relevant information:
+│   reasons, difficulties, links to web references, related issues...
+└------------------------------------------------------------------->
 
+...
 
+<!-------------------------------------------------------------------
+│   Bugs and new features/improvements must be presented and
+│   discussed in an issue first. Please create one if there is no issue
+│   related to this pull request. You can skip this step for minor changes.
+└------------------------------------------------------------------->
+- Closes <!--- ...link to the issue... -->
 
-<!--- Bugs and new features/improvements must be presented and discussed in -->
-<!--- an issue first. Please create one if there is no issue related to     -->
-<!--- this pull request.                                                    -->
-- Closes <!--- link to issue... -->
-
-## Motivation and Context
-<!--- Why is this change required? What problem does it solve?              -->
-
-## Screenshots (if appropriate):
 
 ## Types of changes
-<!--- What types of changes does your code introduce?                       -->
-<!--- Put an `x` in all the boxes that apply:                               -->
+<!-------------------------------------------------------------------
+│   What types of changes does your code introduce?
+│   Fill with [x] all the boxes that apply:
+└------------------------------------------------------------------->
 - [ ] Documentation
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing
-      functionality to change)
-
-## 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.
-- [ ] There are no other pull request similar to this one.
-- [ ] The pull request title is descriptive.
-- [ ] The template is fully and correctly filled.
+- [ ] Breaking change (anything that would change an existing functionality)
+- [ ] Maintenance (refactor, code cleaning, development tools...)
+
+
+## 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.
+- [ ] The pull request title and template are correctly filled.
 - [ ] The pull request targets the right branch (`develop` or `develop-v...`).
 - [ ] My commits are correctly titled and contain all relevant information.
-- [ ] My code follows the code style of this project.
 - [ ] I have updated the documentation accordingly to my changes (if relevant).
 - [ ] I have added tests to cover my changes (if relevant).
-- [ ] All new and existing tests passed.
 
-<!--- --------------------------------------------------------------------- -->
-<!---       For more information, see the CONTRIBUTING.md document          -->
-<!---         Thank you for your pull request and happy coding ;)           -->
-<!--- --------------------------------------------------------------------- -->
+
+<!------------------------------------------------------------------------------
+            For more information, see the CONTRIBUTING.md document         
+              Thank you for your pull request and happy coding ;)          
+------------------------------------------------------------------------------->