Skip to content

Commit 03c538f

Browse files
almicalmic
committed
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.
1 parent c08ec81 commit 03c538f

File tree

5 files changed

+119
-30
lines changed

5 files changed

+119
-30
lines changed

‎.github/ISSUE_TEMPLATE/Bug_report.md‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,42 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
2+
name: Bugs
3+
about: Create a bug report to help us improve
44

55
---
66

7-
- [ ] I have read the [CONTRIBUTING](https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md) file before posting this issue.
7+
<!---
8+
BEFORE YOU SUBMIT please read the following:
89
9-
**Describe the bug**
10+
Please search open/closed issues before submitting since someone might have asked the same thing before!
1011
11-
A clear and concise description of what the bug is.
12+
If you have a support request or question please submit them on StackOverflow:
13+
https://stackoverflow.com/questions/tagged/mpandroidchart
14+
using the tags `android` & `mpandroidchart`
1215
13-
**Screenshots**
16+
Please also look at the CONTRIBUTING file before opening an issue:
17+
https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md
1418
15-
If applicable, add screenshots to help explain your problem.
19+
Issues on GitHub are only related to problems with MPAndroidChart itself and we cannot answer
20+
support questions here. We will close your issue without a response.
21+
-->
1622

17-
**Expected behavior**
23+
**Summary**
24+
<!-- A clear and concise description of what the bug is. -->
1825

19-
A clear and concise description of what you expected to happen.
26+
**Expected Behavior**
27+
<!-- A clear and concise description of what you expected to happen. -->
28+
29+
**Possible Solution**
30+
<!-- Not required, but suggest a fix/ reason for the bug, -->
31+
<!-- or ideas how to implement the addition or change -->
2032

2133
**Device (please complete the following information):**
2234
- Device: [e.g. Google Pixel]
2335
- Android Version [e.g. 7.0]
24-
- Libaray Version (e.g. 3.0.3)
25-
26-
**Additional context**
36+
- Library Version (e.g. 3.0.3)
2737

28-
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.
38+
**Additional Context**
39+
<!-- Add any other context about the problem here.
40+
If you have source code demonstrating this bug, create a Gist:
41+
https://help.github.com/articles/creating-gists/
42+
and link to it here. -->

‎.github/ISSUE_TEMPLATE/Feature_request.md‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,33 @@
11
---
2-
name: Feature request
2+
name: Feature Request
33
about: Suggest an idea for this project
44

55
---
66

7-
- [ ] I have read the [CONTRIBUTING](https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md) file before posting this issue.
7+
<!---
8+
BEFORE YOU SUBMIT please read the following:
9+
10+
Please search open/closed issues before submitting since someone might have asked the same thing before!
11+
12+
If you have a support request or question please submit them on StackOverflow:
13+
https://stackoverflow.com/questions/tagged/mpandroidchart
14+
using the tags `android` & `mpandroidchart`
15+
16+
Please also look at the CONTRIBUTING file before opening an issue:
17+
https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md
18+
19+
Issues on GitHub are only related to problems with MPAndroidChart itself and we cannot answer
20+
support questions here. We will close your issue without a response.
21+
-->
822

923
**Is your feature request related to a problem? Please describe.**
10-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
24+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1125

1226
**Describe the solution you'd like**
13-
A clear and concise description of what you want to happen.
27+
<!-- A clear and concise description of what you want to happen. -->
1428

1529
**Describe alternatives you've considered**
16-
A clear and concise description of any alternative solutions or features you've considered.
30+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1731

1832
**Additional context**
19-
Add any other context or screenshots about the feature request here.
33+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/Support_help.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Support
3+
about: I need help!
4+
5+
---
6+
7+
# *STOP RIGHT THERE!*
8+
9+
Issues are ***NOT*** for getting help, only for reporting bugs and feature requests.
10+
11+
Search open and closed issues to see if your question already has an answer. However, **do not create a new issue.**
12+
13+
Instead, do the following:
14+
15+
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.
16+
17+
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.
18+
19+
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.
20+
21+
22+
### You have been warned!
23+
24+
From now on, any issues asking for help will get closed with a link to this file.

‎ISSUE_TEMPLATE.md‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
1-
- [ ] I have read the [CONTRIBUTING](https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md) file before posting this issue.
1+
<!---
2+
BEFORE YOU SUBMIT please read the following:
3+
4+
Please search open/closed issues before submitting since someone might have asked
5+
the same thing before!
6+
7+
If you have a support request or question please submit them on StackOverflow:
8+
https://stackoverflow.com/questions/tagged/mpandroidchart
9+
using the tags `android` & `mpandroidchart`
10+
11+
Please also look at the CONTRIBUTING file before opening an issue:
12+
https://github.com/PhilJay/MPAndroidChart/blob/master/CONTRIBUTING.md
13+
14+
Issues on GitHub are only related to problems with MPAndroidChart itself and we
15+
cannot answer support questions here. We will close your issue without a response.
16+
-->
17+
18+
**Summary**
19+
<!-- A clear and concise description of what the bug is. -->
20+
21+
**Expected Behavior**
22+
<!-- A clear and concise description of what you expected to happen. -->
23+
24+
**Possible Solution**
25+
<!-- Not required, but suggest a fix/ reason for the bug, -->
26+
<!-- or ideas how to implement the addition or change -->
27+
28+
**Device (please complete the following information):**
29+
- Device: [e.g. Google Pixel]
30+
- Android Version [e.g. 7.0]
31+
- Library Version (e.g. 3.0.3)
32+
33+
**Additional Context**
34+
<!-- Add any other context about the problem here.
35+
If you have source code demonstrating this bug, create a Gist:
36+
https://help.github.com/articles/creating-gists/
37+
and link to it here. -->

‎PULL_REQUEST_TEMPLATE.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
- [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) file before posting submitting this pull request.
1+
## PR Checklist:
2+
- [ ] I have tested this extensively and it does not break any existing behavior.
3+
- [ ] I have added/updated examples and tests for any new behavior.
4+
- [ ] 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]
5+
<!-- If you'd like to suggest a significant change, please
6+
create an issue to discuss those changes and gather
7+
feedback BEFORE submitting your PR. -->
28

3-
Before describing this pull request, please prefix the title with a topic from the list:
4-
`Feature`, `Fix`, `Style`
59

6-
### [Feature / Fix / Style] (choose ONE)
10+
## PR Description
11+
<!-- Describe Your PR Here! -->
712

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

10-
If a bug fix, reference any issues that this fixes, like so: "fixes #99"
11-
12-
### Why should this be merged?
13-
14-
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.
15+
<!-- WHY should this PR be merged into the main library? -->

0 commit comments

Comments
 (0)