about summary refs log tree commit diff stats
path: root/.github
diff options
context:
space:
mode:
authornfnty <git@nfnty.se>2017-01-16 02:04:59 +0100
committernfnty <git@nfnty.se>2017-01-16 02:50:00 +0100
commit64845d2a45844aa683756a4830e82feba525f1c0 (patch)
treee52b364dad18c519074e476fa2e139535e9f8447 /.github
parent03ed2a43a1a80c69d1a9590e3e04fdb9317791ff (diff)
downloadranger-64845d2a45844aa683756a4830e82feba525f1c0.tar.gz
GitHub issue templates: Reorder and improve editability
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md47
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md64
2 files changed, 62 insertions, 49 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index a62f089e..45d9c54a 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,43 +1,52 @@
 <!-- Provide a descriptive summary of the issue in the title above -->
+<!-- First verify that the issue hasn't already been reported -->
+<!-- Also test if the latest release and master branch are affected too -->
 
-## Expected behavior
+#### ISSUE TYPE
+<!-- Pick one and delete the rest -->
+- Bug report
+- Improvement/feature request
+
+#### RUNTIME ENVIRONMENT
+<!-- Include details of your runtime environment -->
+- Ranger version/commit: 
+- Python version: 
+- Operating system and version: 
+
+#### EXPECTED BEHAVIOR
 <!-- Bug: What should happen? -->
-<!-- Improvement: How should it work? -->
+<!-- Request: How should it work? -->
 
 
-## Current behavior
+#### CURRENT BEHAVIOR
 <!-- Bug: How is it different from the expected behavior? -->
-<!-- Improvement: How does it change the current behavior? -->
+<!-- Request: How does it change the current behavior? -->
 
 
-## Possible solution
+#### POSSIBLE SOLUTIONS
 <!-- Bug: How should it be fixed? -->
-<!-- Improvement: How should it be implemented? -->
+<!-- Request: How should it be implemented? -->
 
 
-## Context
+#### CONTEXT
 <!-- How has this issue affected you? -->
 <!-- What are you trying to accomplish? -->
 
 
-## Steps to reproduce<!-- For bugs -->
-<!-- List unambiguous steps to reproduce this bug -->
+#### STEPS TO REPRODUCE<!-- For bugs -->
+<!-- List unambiguous steps to reproduce the bug -->
 1. 
 2. 
 3. 
 4. 
 5. 
 
-
-## Traceback<!-- For crashes -->
+#### TRACEBACK<!-- For crashes -->
 <!-- Run ranger in debug mode -->
+<!-- Paste between quotes -->
+```
 
+```
 
-## Screenshots/Video<!-- Only if relevant -->
-
-
-## Runtime environment
-<!-- Include details of your runtime environment -->
-- Ranger version/commit: 
-- Python version: 
-- Operating system and version: 
+#### IMAGES / VIDEOS<!-- Only if relevant -->
+<!-- Link or embed images and videos of screenshots, sketches etc. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 3686c8b3..e9b644f4 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,40 +1,44 @@
-<!-- Provide a descriptive summary of your changes in the title above -->
+<!-- Provide a descriptive summary of the changes in the title above -->
 
-## Types of changes
-<!-- Remove lines that don't apply -->
-- 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)
+#### ISSUE TYPE
+<!-- Pick relevant types and delete the rest -->
+- Bug fix
+- Improvement/feature implementation
+- Breaking changes
 
-## Description
-<!-- Describe your changes in detail -->
+#### RUNTIME ENVIRONMENT
+<!-- Include details of your runtime environment -->
+- Ranger version/commit: 
+- Python version: 
+- Operating system and version: 
 
+#### CHECKLIST
+<!-- All [REQUIRED] requisites need to be fulfilled -->
+<!-- Replace [ ] with [X] when fulfilled -->
+- [ ] The `CONTRIBUTING` document has been read **[REQUIRED]**
+- [ ] All changes follow the code style **[REQUIRED]**
+- [ ] All new and existing tests pass **[REQUIRED]**
+- [ ] Changes require config files to be updated
+    - [ ] Config files have been updated
+- [ ] Changes require documentation to be updated
+    - [ ] Documentation has been updated
+- [ ] Changes require tests to be updated
+    - [ ] Tests have been updated
 
-## Motivation and context
-<!-- Why is this change required? -->
-<!-- What problem does it solve? -->
-<!-- Link to relevant issue(s) -->
+#### DESCRIPTION
+<!-- Describe the changes in detail -->
 
 
-## Testing
-<!-- What's your testing environment? -->
-<!-- What tests have you run? -->
-<!-- How does your changes affect other areas of the codebase? -->
+#### MOTIVATION AND CONTEXT
+<!-- Why are these changes required? -->
+<!-- What problem does it solve? -->
+<!-- Link to relevant issues -->
 
 
-## Screenshots/Video<!-- Only if relevant -->
+#### TESTING
+<!-- What tests have been run? -->
+<!-- How does the changes affect other areas of the codebase? -->
 
 
-## Checklist
-<!-- Please go over all the following points -->
-<!-- Replace [ ] with [X] when fulfilled -->
-<!-- All [REQUIRED] requisites need to be fulfilled -->
-- [ ] The **CONTRIBUTING** document has been read **[REQUIRED]**
-- [ ] All changes follow the code style of this project **[REQUIRED]**
-- [ ] All new and existing tests pass **[REQUIRED]**
-- [ ] Changes require documentation to be updated
-    - [ ] Documentation has been updated
-- [ ] Changes require config files to be updated
-    - [ ] Config files have been updated
-- [ ] Changes require tests to be updated
-    - [ ] Tests have been updated
+#### IMAGES / VIDEOS<!-- Only if relevant -->
+<!-- Link or embed images and videos of screenshots, sketches etc. -->