Docs(github): update github related docs

Armour · Aug 13, 2018 · 3c372f3 · 3c372f3
1 parent 737f364
commit 3c372f3
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 29 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -4,16 +4,19 @@ PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATI
 ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
 -->
 
-# I'm submitting a
+<!-- Please search GitHub for a similar issue or PR before submitting -->
 
-<!-- Check one of the following options with "x" -->
+# I'm submitting a
 
-[ ] Bug report  <!-- Please search GitHub for a similar issue or PR before submitting -->
-[ ] Feature request
-[ ] Performance issue
-[ ] Regression (a behavior that used to work and stopped working in a new release)
-[ ] Documentation issue or request
-[ ] Other... Please describe:
+<!-- 
+E.g.
+    bug report,
+    feature request,
+    performance issue,
+    regression (a behavior that used to work and stopped working in a new release),
+    documentation issue or request,
+    or others... (please describe)
+-->
 
 ## Current behavior
 
@@ -29,7 +32,7 @@ ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
 For bug reports please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via github repo or similar tools.
 -->
 
-## What is the motivation / use case for changing the behavior?
+## What is the motivation / use case for changing the behavior
 
 <!-- Describe the motivation or the concrete use case. -->
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -4,30 +4,25 @@ https://github.com/Armour/Magic-Tower-Qt/blob/master/.github/CONTRIBUTING.md#sub
 -->
 
 <!-- PULL REQUEST TEMPLATE -->
-<!-- (Update "[ ]" to "[x]" to check a box) -->
 
-**What kind of change does this PR introduce?** (check at least one)
+**Make sure the PR fulfills these requirements:**
 
-- [ ] Bugfix
-- [ ] Feature
-- [ ] Code style update
-- [ ] Refactor
-- [ ] Build-related changes
-- [ ] Other, please describe:
+- When resolving a specific issue, make sure it's referenced in the PR's title (e.g. `Closes #xxx[,#xxx]`, where "xxx" is the issue number)
 
-**Does this PR introduce a breaking change?** (check one)
+- If adding a **new feature**, the PR's description includes: A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
 
-- [ ] Yes
-- [ ] No
+- If this PR introduce a **breaking change**, please describe the impact and migration path for existing applications
 
-If yes, please describe the impact and migration path for existing applications:
+**What kind of change does this PR introduce?**
 
-**The PR fulfills these requirements:**
-
-- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `Closes #xxx[,#xxx]`, where "xxx" is the issue number)
-
-If adding a **new feature**, the PR's description includes:
-
-- [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
+<!--
+E.g.
+    bugfix,
+    feature,
+    code style update,
+    refactor,
+    build-related changes,
+    or others... (please describe)
+-->
 
-**Other information:**
+**More information:**