]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
chore: simplify the GitHub pull request template
authorNicolas Coden <nicolas@ncoden.fr>
Mon, 20 Aug 2018 21:50:20 +0000 (23:50 +0200)
committerNicolas Coden <nicolas@ncoden.fr>
Mon, 20 Aug 2018 21:50:20 +0000 (23:50 +0200)
.github/PULL_REQUEST_TEMPLATE.md

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 ;)          
+------------------------------------------------------------------------------->