-
Notifications
You must be signed in to change notification settings - Fork 306
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update github templates to be more template'ish
- Loading branch information
1 parent
da0db23
commit b963945
Showing
2 changed files
with
56 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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!) | ||
## 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* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. :) |