]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
chore: improve GitHub templates readibility in text format
authorNicolas Coden <nicolas@ncoden.fr>
Fri, 20 Apr 2018 23:44:12 +0000 (01:44 +0200)
committerNicolas Coden <nicolas@ncoden.fr>
Fri, 20 Apr 2018 23:44:12 +0000 (01:44 +0200)
Changes:
* limite lines lenght to 80 characters
* add centering and left/right alignement of texts
* use `-` instead of `*` for lists

.github/ISSUE_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE.md

index 317109812be36ba175fe47435347ae6f58c13037..28b69bf6f3fe327cccc071d2bc9350a39ba9c281 100644 (file)
@@ -1,50 +1,59 @@
-<!--- Please fill the following template. Your issue may be closed otherwise. -->
-<!--- Only submit here bug reports or a feature requests. For help or questions -->
-<!--- to the community, see the forum http://foundation.zurb.com/forum -->
+<!--- --------------------------------------------------------------------- -->
+<!---                 Please fill the following template                    -->
+<!---                 Your issue may be ignored otherwise                   -->
+<!--- --------------------------------------------------------------------- -->
+<!---  Only submit here bug or feature requests. For help or questions to   -->
+<!---  the community, see the forum: https://foundation.zurb.com/forum      -->
 
 ## Expected Behavior
-<!--- If you're describing a bug, tell us what should happen -->
-<!--- If you're suggesting a change/improvement, tell us why and how it should work -->
+<!--- If describing a bug, tell us what should happen.                      -->
+<!--- If suggesting a change/feature, tell us why and how it should work.   -->
 
 ## Current Behavior
-<!--- If describing a bug, tell us what happens instead of the expected behavior -->
-<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+<!--- If describing a bug, tell us what happens instead.                    -->
+<!--- If suggesting a change/feature, explain the difference from           -->
+<!--- current behavior.                                                     -->
 
 ## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug, -->
-<!--- or ideas how to implement the addition or change -->
+<!--- Not obligatory, but 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 recommand you to provide a live example of your bug so we can reproduce it -->
-<!--- Create a test case with the last version by forking https://codepen.io/ncoden/pen/YLzjeq -->
-**Test Case**: <!-- https://... -->
-
-<!--- If you cannot provide a test case (i.e. for a Sass bug), provide an unambiguous
-<!--- set of steps to reproduce, with your code and configuration. -->
-**How to reproduce:**
+<!--- We highly recommand 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 -->
+<!--- 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 environment you experienced the bug in -->
-* Foundation version(s) used:
-* Browser(s) Name and version(s):
-* Operating System and version (desktop or mobile):
-* Link to your project:
+<!--- 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. All checkboxes are required! -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+<!--- 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 the [CONTRIBUTING](CONTRIBUTING.md) document.
 - [ ] This is a bug report or a feature request.
 - [ ] There is no other issues similar to this one.
 - [ ] The issue title is descriptive.
 - [ ] The template is fully and 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 issue and happy coding ;)               -->
+<!--- --------------------------------------------------------------------- -->
index b7e45ce313e3d439a6c77c2df73b700f9f3c8f3e..a3d15a546aeae47c2477e30c33c72060b5882623 100644 (file)
@@ -1,29 +1,38 @@
-<!--- Please fill the following template. Your pull request may be ignored otherwise. -->
+<!--- --------------------------------------------------------------------- -->
+<!---                 Please fill the following template                    -->
+<!---             Your pull request may be ignored otherwise                -->
+<!--- --------------------------------------------------------------------- -->
 
 ## Description
 <!--- Describe your changes in detail -->
 
-<!--- This project only accepts pull requests related to open issues -->
-<!--- If suggesting a new feature or change, please discuss it in an issue first -->
-<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
-<!--- If improving the documentation or fixing typo, you can ignore this -->
+
+
+<!--- This project only accepts pull requests related to open issues.       -->
+<!--- * If improving the documentation or fixing typo, you can ignore this. -->
+<!--- * If suggesting a new feature or change, please discuss it in an      -->
+<!---   issue first.                                                        -->
+<!--- * If fixing a bug, there should be an issue describing it with steps  -->
+<!---   to reproduce.                                                       -->
 - Closes <!--- link to issue... -->
 
 ## Motivation and Context
-<!--- Why is this change required? What problem does it solve? -->
+<!--- 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?                       -->
+<!--- Put an `x` in 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)
+- [ ] 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. All checkboxes are required! -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+<!--- 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 the [CONTRIBUTING](CONTRIBUTING.md) document.
 - [ ] There is no other pull request similar to this one.
 - [ ] The pull request title is descriptive.
@@ -34,5 +43,7 @@
 - [ ] 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 ;)           -->
+<!--- --------------------------------------------------------------------- -->