From 1e973e10734dba877b8d41c701b678a9d0682495 Mon Sep 17 00:00:00 2001 From: Eli White Date: Tue, 9 Aug 2016 04:35:49 -0700 Subject: [PATCH] Updating our issue and PR templates to be more helpful --- .github/ISSUE_TEMPLATE.md | 12 ++++++++++-- .github/PULL_REQUEST_TEMPLATE.md | 18 +++++++++++++----- 2 files changed, 23 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a1d7168e75..e5a3f1f317 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,7 @@ -Please check configuration at http://jsonlint.com/ before posting an issue. +## Stop! Before you create this issue (you can delete this section when opening the issue): +1. Have you validated that your config.json is valid JSON? Use http://jsonlint.com/ to check. +2. Have you searched to see if there are other issues for the same issue? If so, comment on that issue instead. +3. Are you running `master`? We work on the `dev` branch and then add that functionality to `master`. Your issue may be fixed on `dev` and there is no need for this issue, just wait and it will eventually be merged to `master`. ### Expected Behavior @@ -6,10 +9,15 @@ Please check configuration at http://jsonlint.com/ before posting an issue. ### Actual Behavior +### Your config.json (remove your credentials and any other private info) +``` +your config here +``` + ### Steps to Reproduce ### Other Information -OS: +OS: Git Commit: (run 'git log -n 1 --pretty=format:"%H"' and paste it here) Python Version: (run 'python -V' and paste it here) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5178d928b5..a43df95477 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,15 @@ -Short Description: +# Please Note (you may remove this section before opening your PR): +We receive lots of PRs and it is hard to give proper review to PRs. Please make it easy on us by following these guidelines: -Fixes: -- -- -- +1. We do not accept changes to `master`. Please make sure your pull request is aimed at `dev`. +2. If you changed a bunch of files (that aren't config files) or multiple workers to implement your feature, it probably won't get proper attention. Please split it up into multiple, smaller, more focused, and iterative PRs if you can. +3. If you are adding a config value to something, make sure you update the appropriate `config.json` example files. + + +## Short Description: + +## Fixes (provide links to github issues if you can): +- +- +-