From da0db23c24bc997d9106d892191e18d8e7acea4e Mon Sep 17 00:00:00 2001 From: Michael Gallaspy Date: Thu, 18 Feb 2016 10:24:18 -0800 Subject: [PATCH 1/3] Add issue and pr templates --- .github/ISSUE_TEMPLATE.md | 6 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 7 +++++++ 2 files changed, 13 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..7079b0e8a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,6 @@ +Please include the following information when opening an issue: +- [ ] The branch or version of KA Lite you found the issue on +- [ ] The current date / the build that the issue affects +- [ ] Expected behavior +- [ ] Actual behavior +- [ ] Steps to reproduce (be detailed!) \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..25f5395434 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +If opening a PR, please observe the following guidelines: +- [ ] If you're fixing a bug, write a regression test (or have a really good reason for not writing one... and I mean **really** good!) +- [ ] Additionally, add in a "Fixes `issue number`" for PRs that address a certain issue (e.g. "Fixes #3390"). +- [ ] If your PR changes or adds to the User Interface, please include screenshots in either the description or the comments. +- [ ] Give a brief summary of your changes in the PR description. Add in any other notes that are important for the reviewer to know. +- [ ] Update the documentation if your changes affect it (don't just assume they don't, please double check). +- [ ] Double check your own code for good style. From b963945e10f461b6ef9d56e1f1242104694fc33f Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Thu, 18 Feb 2016 21:57:52 +0100 Subject: [PATCH 2/3] Update github templates to be more template'ish --- .github/ISSUE_TEMPLATE.md | 34 +++++++++++++++++++++++++------ .github/PULL_REQUEST_TEMPLATE.md | 35 +++++++++++++++++++++++++------- 2 files changed, 56 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 7079b0e8a6..c0d4b1e721 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,28 @@ -Please include the following information when opening an issue: -- [ ] The branch or version of KA Lite you found the issue on -- [ ] The current date / the build that the issue affects -- [ ] Expected behavior -- [ ] Actual behavior -- [ ] Steps to reproduce (be detailed!) \ No newline at end of file +## Summary + +Briefly describe what this is about + +## Branch or installer method + +PLEASE SPECIFY IF YOU ARE USING THE CURRENT `develop` BRANCH OR WHICH INSTALLATION +SOURCE (Windows / Debian / OSX) AND WHICH VERSION (0.15, 0.16 etc) + +## Traceback or relevant snippet from server.log + +``` +INSERT TRACEBACK, LOG MESSAGES ETC. HERE +``` + +## How to reproduce + +1. STEPS +1. TO +1. REPRODUCE + +## Screenshots + +*If applicable* + +## Real-life consequences (anything community should be aware, for instance how it affects your deployment) + +*If applicaple* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 25f5395434..161dd11f38 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,28 @@ -If opening a PR, please observe the following guidelines: -- [ ] If you're fixing a bug, write a regression test (or have a really good reason for not writing one... and I mean **really** good!) -- [ ] Additionally, add in a "Fixes `issue number`" for PRs that address a certain issue (e.g. "Fixes #3390"). -- [ ] If your PR changes or adds to the User Interface, please include screenshots in either the description or the comments. -- [ ] Give a brief summary of your changes in the PR description. Add in any other notes that are important for the reviewer to know. -- [ ] Update the documentation if your changes affect it (don't just assume they don't, please double check). -- [ ] Double check your own code for good style. +## Summary + +*Short description* + +## TODO + +If not all TODOs are marked, this PR is considered WIP (work in progress) + +- [ ] Have **tests** been written for the new code? If you're fixing a bug, write a regression test (or have a really good reason for not writing one... and I mean **really** good!) +- [ ] Has documentation been written/updated? +- [ ] New dependencies (if any) added to requirements file +- [ ] Add an entry to CHANGELOG.rst + +## Reviewer guidance + +*If you PR has a significant size, give the reviewer some helpful remarks* + +## Issues addressed + +List the issues solved or partly solved by the PR + +## Documentation + +If the PR has documentation, link the file here (either .rst in your repo or if built on Read The Docs) + +## Screenshots (if appropriate) + +They're nice. :) From d3e0c227017a381a6818397a13ec259ffb0ceef0 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Thu, 18 Feb 2016 22:03:26 +0100 Subject: [PATCH 3/3] consistency in caps, some extra line breaks and a better template for branch/installer [ci skip] --- .github/ISSUE_TEMPLATE.md | 21 +++++++++++++++------ .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c0d4b1e721..29d2f60209 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,11 +1,19 @@ ## Summary -Briefly describe what this is about +*Briefly describe what this is about* + ## Branch or installer method -PLEASE SPECIFY IF YOU ARE USING THE CURRENT `develop` BRANCH OR WHICH INSTALLATION -SOURCE (Windows / Debian / OSX) AND WHICH VERSION (0.15, 0.16 etc) +*Please specify if you are using the current `develop` branch or which installation source you were using when the issue occurred.* + + - Installer: Windows/OSX/Debian (?) + - Version: 0.15.1 (?) + +or: + + - Branch: develop (?) + ## Traceback or relevant snippet from server.log @@ -13,11 +21,12 @@ SOURCE (Windows / Debian / OSX) AND WHICH VERSION (0.15, 0.16 etc) INSERT TRACEBACK, LOG MESSAGES ETC. HERE ``` + ## How to reproduce -1. STEPS -1. TO -1. REPRODUCE +1. Steps +1. To +1. Reproduce ## Screenshots diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 161dd11f38..da12dddf1f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -21,8 +21,8 @@ List the issues solved or partly solved by the PR ## Documentation -If the PR has documentation, link the file here (either .rst in your repo or if built on Read The Docs) +*If the PR has documentation, link the file here (either .rst in your repo or if built on Read The Docs)* ## Screenshots (if appropriate) -They're nice. :) +*They're nice. :)*