From 03c538fc34a945a27a1a636410b0819e56a7c355 Mon Sep 17 00:00:00 2001 From: almic Date: Sun, 6 May 2018 00:02:06 -0600 Subject: [PATCH] docs(templates): Update Issue & PR templates I've updated the issue and pull request templates, again. This time I looked to the node.js request library for inspiration. It's no secret that this project has been attracting a LOT of very low-quality issues. Almost all are asking questions that can be easily answered if the person looked at the example project or the wiki. Specifically, the new Support_help.md file. This file will hopefully bait these low-quality support questions and reduce the number of opened issues regarding debugging or support significantly. I've updated the default ISSUE_TEMPLATE.md to be a copy of Bug_report.md to force people to read that notice text if they decide to not choose any of the templates. --- .github/ISSUE_TEMPLATE/Bug_report.md | 40 +++++++++++++++-------- .github/ISSUE_TEMPLATE/Feature_request.md | 26 +++++++++++---- .github/ISSUE_TEMPLATE/Support_help.md | 24 ++++++++++++++ ISSUE_TEMPLATE.md | 38 ++++++++++++++++++++- PULL_REQUEST_TEMPLATE.md | 21 ++++++------ 5 files changed, 119 insertions(+), 30 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Support_help.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index a816dd5bed..496d0a0d8d 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,28 +1,42 @@ --- -name: Bug report -about: Create a report to help us improve +name: Bugs +about: Create a bug report to help us improve --- -- [ ] I have read the [CONTRIBUTING](https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md) file before posting this issue. + -**Expected behavior** +**Summary** + -A clear and concise description of what you expected to happen. +**Expected Behavior** + + +**Possible Solution** + + **Device (please complete the following information):** - Device: [e.g. Google Pixel] - Android Version [e.g. 7.0] - - Libaray Version (e.g. 3.0.3) - -**Additional context** + - Library Version (e.g. 3.0.3) -Add any other context about the problem here. If you have source code demonstrating this bug, create a [Gist](https://help.github.com/articles/creating-gists/) and link to it. +**Additional Context** + diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 85bcdbea3c..823b940961 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,19 +1,33 @@ --- -name: Feature request +name: Feature Request about: Suggest an idea for this project --- -- [ ] I have read the [CONTRIBUTING](https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md) file before posting this issue. + **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + **Describe the solution you'd like** -A clear and concise description of what you want to happen. + **Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. + **Additional context** -Add any other context or screenshots about the feature request here. + diff --git a/.github/ISSUE_TEMPLATE/Support_help.md b/.github/ISSUE_TEMPLATE/Support_help.md new file mode 100644 index 0000000000..64c87763df --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Support_help.md @@ -0,0 +1,24 @@ +--- +name: Support +about: I need help! + +--- + +# *STOP RIGHT THERE!* + +Issues are ***NOT*** for getting help, only for reporting bugs and feature requests. + +Search open and closed issues to see if your question already has an answer. However, **do not create a new issue.** + +Instead, do the following: + +1. Download the [Example App](https://play.google.com/store/apps/details?id=com.xxmassdeveloper.mpchartexample) and check out the [source code](https://github.com/PhilJay/MPAndroidChart/tree/master/MPChartExample/src/com/xxmassdeveloper/mpchartexample). 90% of the time there is an example that does exactly what you are trying to do. + +1. Look at the [Wiki](https://github.com/PhilJay/MPAndroidChart/wiki) for the official documentation for MPAndroidChart. You can also browse the [javadoc](https://jitpack.io/com/github/PhilJay/MPAndroidChart/v3.0.3/javadoc/) for a more detailed tutorial of the API. + +1. Go to [StackOverflow](https://stackoverflow.com/questions/tagged/mpandroidchart) and ask your questions there. The community will be much more helpful and willing to offer guidance. + + +### You have been warned! + +From now on, any issues asking for help will get closed with a link to this file. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 65e0e5d643..49ed0dfc1d 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1 +1,37 @@ -- [ ] I have read the [CONTRIBUTING](https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md) file before posting this issue. + + +**Summary** + + +**Expected Behavior** + + +**Possible Solution** + + + +**Device (please complete the following information):** + - Device: [e.g. Google Pixel] + - Android Version [e.g. 7.0] + - Library Version (e.g. 3.0.3) + +**Additional Context** + diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index fb64ddf8be..f65a30b178 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,15 @@ -- [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) file before posting submitting this pull request. +## PR Checklist: +- [ ] I have tested this extensively and it does not break any existing behavior. +- [ ] I have added/updated examples and tests for any new behavior. +- [ ] If this is a significant change, an issue has already been created where the problem / solution was discussed: [N/A, or add link to issue here] + -Before describing this pull request, please prefix the title with a topic from the list: -`Feature`, `Fix`, `Style` -### [Feature / Fix / Style] (choose ONE) +## PR Description + -What will this PR do? Remember that you don't need to explain everything, let the changes speak for itself. + -If a bug fix, reference any issues that this fixes, like so: "fixes #99" - -### Why should this be merged? - -If needed, further explain this PR and why it should be merged. If the changes are too broad, your pull request may be denied for having too much in it. It may also be denied if the commits aren't properly formatted. +