-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Add more specific GitHub issue templates #18161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
6a3f55a
add feature request template
ianhi e4f58f4
tighten language
ianhi 7af95ab
create documentation and enhancment templates
ianhi b75555d
use existing issue label
ianhi 47927a9
add more examples + remove enhancement codesnippet
ianhi 1f89ebf
clarify maintenance template and create question template
ianhi d9aee8e
correct labels of issue templates
ianhi 033fefe
remove period for consistency + remove extraneous line
ianhi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
5 changes: 5 additions & 0 deletions
5
.github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/bug_report.md
This file contains hidden or 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
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
|
||
--- | ||
name: Documentation improvement | ||
about: Create a report to help us improve the documentation. | ||
label: Documentation | ||
--- | ||
|
||
<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.--> | ||
<!--You can feel free to delete the sections that do not apply.--> | ||
|
||
### Problem | ||
|
||
<!-- | ||
If you are referencing an existing piece of documentation or example please provide a link. | ||
|
||
* I found [...] to be unclear because [...] | ||
* [...] made me think that [...] when really it should be [...] | ||
* There is no example showing how to do [...] | ||
--> | ||
|
||
|
||
### Suggested Improvement | ||
|
||
<!-- | ||
If you have an idea to improve the documentation please suggest it here | ||
|
||
* This line should be be changed to say [...] | ||
* Include a paragraph explaining [...] | ||
--> | ||
ianhi marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Enhancement | ||
about: Help improve performance, usability and/or consistency. | ||
label: maintenance | ||
--- | ||
|
||
### Describe the issue | ||
|
||
**Summary** | ||
|
||
<!-- A short 1-2 sentences that succinctly describe what could be improved --> | ||
|
||
**Code example** | ||
<!--A minimal code snippet required to reproduce the bug. | ||
Please make sure to minimize the number of dependencies required, and provide | ||
any necessary plotted data | ||
--> | ||
|
||
ianhi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```python | ||
# paste your code here | ||
# | ||
# | ||
``` | ||
|
||
### Proposed fix | ||
|
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest something to add to Matplotlib | ||
labels: New Feature | ||
ianhi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--- | ||
|
||
<!-- | ||
Welcome! Thanks for thinking of a way to improve Matplotlib. | ||
|
||
|
||
Before creating a new feature request please search the issues for relevant feature requests. | ||
--> | ||
|
||
### Problem | ||
|
||
<!-- | ||
Provide a clear and concise description of the problem this feature will solve. | ||
|
||
For example: | ||
* I'm always frustrated when [...] because [...] | ||
* I would like it if [...] happened when I [...] because [...] | ||
--> | ||
|
||
ianhi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
### Proposed Solution | ||
|
||
<!-- Provide a clear and concise description of a way to accomplish what you want. For example: | ||
|
||
* Add an option so that when [...] [...] will happen | ||
--> | ||
|
||
### Additional context and prior art | ||
|
||
<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example: | ||
|
||
* Another project [...] solved this by [...] | ||
--> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.