Skip to content

Commit

Permalink
docs(templates): Update Issue & PR templates
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
almic committed May 6, 2018
1 parent c08ec81 commit 03c538f
Show file tree
Hide file tree
Showing 5 changed files with 119 additions and 30 deletions.
40 changes: 27 additions & 13 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
<!---
BEFORE YOU SUBMIT please read the following:
**Describe the bug**
Please search open/closed issues before submitting since someone might have asked the same thing before!
A clear and concise description of what the bug is.
If you have a support request or question please submit them on StackOverflow:
https://stackoverflow.com/questions/tagged/mpandroidchart
using the tags `android` & `mpandroidchart`
**Screenshots**
Please also look at the CONTRIBUTING file before opening an issue:
https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md
If applicable, add screenshots to help explain your problem.
Issues on GitHub are only related to problems with MPAndroidChart itself and we cannot answer
support questions here. We will close your issue without a response.
-->

**Expected behavior**
**Summary**
<!-- A clear and concise description of what the bug is. -->

A clear and concise description of what you expected to happen.
**Expected Behavior**
<!-- A clear and concise description of what you expected to happen. -->

**Possible Solution**
<!-- Not required, but suggest a fix/ reason for the bug, -->
<!-- or ideas how to implement the addition or change -->

**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**
<!-- 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 here. -->
26 changes: 20 additions & 6 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
<!---
BEFORE YOU SUBMIT please read the following:
Please search open/closed issues before submitting since someone might have asked the same thing before!
If you have a support request or question please submit them on StackOverflow:
https://stackoverflow.com/questions/tagged/mpandroidchart
using the tags `android` & `mpandroidchart`
Please also look at the CONTRIBUTING file before opening an issue:
https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md
Issues on GitHub are only related to problems with MPAndroidChart itself and we cannot answer
support questions here. We will close your issue without a response.
-->

**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 [...]
<!-- 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.
<!-- 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.
<!-- 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.
<!-- Add any other context or screenshots about the feature request here. -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/Support_help.md
Original file line number Diff line number Diff line change
@@ -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.
38 changes: 37 additions & 1 deletion ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
- [ ] I have read the [CONTRIBUTING](https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md) file before posting this issue.
<!---
BEFORE YOU SUBMIT please read the following:
Please search open/closed issues before submitting since someone might have asked
the same thing before!
If you have a support request or question please submit them on StackOverflow:
https://stackoverflow.com/questions/tagged/mpandroidchart
using the tags `android` & `mpandroidchart`
Please also look at the CONTRIBUTING file before opening an issue:
https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md
Issues on GitHub are only related to problems with MPAndroidChart itself and we
cannot answer support questions here. We will close your issue without a response.
-->

**Summary**
<!-- A clear and concise description of what the bug is. -->

**Expected Behavior**
<!-- A clear and concise description of what you expected to happen. -->

**Possible Solution**
<!-- Not required, but suggest a fix/ reason for the bug, -->
<!-- or ideas how to implement the addition or change -->

**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**
<!-- 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 here. -->
21 changes: 11 additions & 10 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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]
<!-- If you'd like to suggest a significant change, please
create an issue to discuss those changes and gather
feedback BEFORE submitting your PR. -->

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
<!-- Describe Your PR Here! -->

What will this PR do? Remember that you don't need to explain everything, let the changes speak for itself.
<!-- What does this add/ remove/ fix/ change? -->

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.
<!-- WHY should this PR be merged into the main library? -->

0 comments on commit 03c538f

Please sign in to comment.