-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
ADMIN: Create separate issue templates for different use cases #31551
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
Closed
Closed
Changes from all commits
Commits
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
23 changes: 14 additions & 9 deletions
23
.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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,34 @@ | ||
#### Code Sample, a copy-pastable example if possible | ||
--- | ||
name: Bug Report | ||
about: Create a bug report to help us improve pandas | ||
title: "BUG:" | ||
labels: "" | ||
|
||
--- | ||
|
||
#### Code Sample, a copy-pastable example | ||
|
||
```python | ||
# Your code here | ||
|
||
``` | ||
|
||
**Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to provide the necessary information for us to reproduce your bug. | ||
|
||
#### Problem description | ||
|
||
[this should explain **why** the current behaviour is a problem and why the expected output is a better solution.] | ||
[this should explain **why** the current behaviour is a problem and why the expected output is a better solution] | ||
|
||
**Note**: We receive a lot of issues on our GitHub tracker, so it is very possible that your issue has been posted before. Please check first before submitting so that we do not have to handle and close duplicates! | ||
|
||
**Note**: Many problems can be resolved by simply upgrading `pandas` to the latest version. Before submitting, please check if that solution works for you. If possible, you may want to check if `master` addresses this issue, but that is not necessary. | ||
|
||
For documentation-related issues, you can check the latest versions of the docs on `master` here: | ||
|
||
https://pandas-docs.github.io/pandas-docs-travis/ | ||
|
||
If the issue has not been resolved there, go ahead and file it in the issue tracker. | ||
|
||
#### Expected Output | ||
|
||
#### Output of ``pd.show_versions()`` | ||
|
||
<details> | ||
|
||
[paste the output of ``pd.show_versions()`` here below this line] | ||
[paste the output of ``pd.show_versions()`` here leaving a blank line after the details tag] | ||
|
||
</details> |
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,17 @@ | ||
--- | ||
name: Documentation Enhancement | ||
about: Report needed documentation | ||
title: "DOC:" | ||
labels: "" | ||
|
||
--- | ||
|
||
#### Report needed documentation | ||
|
||
[this should provide a description of what documentation you believe is needed and why] | ||
|
||
**Note**: You can check the latest versions of the docs on `master` [here](https://dev.pandas.io/docs). | ||
|
||
#### Describe the documentation you'd like | ||
|
||
[this should provide a clear and concise description of what you want to happen] |
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,30 @@ | ||
--- | ||
name: Documentation Error | ||
about: Report incorrect documentation | ||
title: "DOC:" | ||
labels: "" | ||
|
||
--- | ||
|
||
#### Location of incorrect documentation | ||
|
||
[this should provide links and line numbers to the incorrect documentation] | ||
|
||
**Note**: You can check the latest versions of the docs on `master` [here](https://dev.pandas.io/docs). | ||
|
||
#### Describe the problems or issues found in the documentation | ||
|
||
[this should explain **why** the current documentation is a problem] | ||
|
||
#### Suggested fix for documentation | ||
|
||
[this should explain the suggested fix and **why** it's better than the existing documentation] | ||
|
||
#### Steps taken to verify documentation is incorrect | ||
|
||
[this should detail steps you've taken to verify the documentation is incorrect, with code examples, if applicable] | ||
|
||
```python | ||
# Your code here, if applicable | ||
|
||
``` |
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,28 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for pandas | ||
title: "ENH:" | ||
labels: "" | ||
|
||
--- | ||
|
||
#### Is your feature request related to a problem? | ||
|
||
[this should provide a description of what the problem is, e.g. "I wish I could use pandas to do [...]"] | ||
|
||
#### Describe the solution you'd like | ||
|
||
[this should provide a description of the feature request, e.g. "`DataFrame.foo` should get a new parameter `bar` that [...]"] | ||
|
||
#### Describe alternatives you've considered | ||
|
||
[this should provide a description of any alternative solutions or features you've considered] | ||
|
||
#### Additional context | ||
|
||
[add any other context, code examples, or references to existing implementations about the feature request here] | ||
|
||
```python | ||
# Your code here, if applicable | ||
|
||
``` |
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,19 @@ | ||
--- | ||
name: Submit Question | ||
about: Ask a general question about pandas | ||
title: "QST:" | ||
labels: "" | ||
|
||
--- | ||
|
||
#### Question about pandas | ||
|
||
**Note**: It's highly recommended that you use [StackOverflow](https://www.stackoverflow.com) for any usage related questions, e.g. "How do I do [...] with pandas?" You are much more likely to receive a quick response to your question on StackOverflow than the GitHub issue tracker. You may also want to search the [pandas tag](https://stackoverflow.com/questions/tagged/pandas) on StackOverflow to see if a similar question has already been asked and answered. | ||
|
||
**Note**: If you'd still like to submit a question, please read [this guide]( | ||
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to provide the necessary information for us to reproduce your question. | ||
|
||
```python | ||
# Your code here, if applicable | ||
|
||
``` |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've left labels blank for now but we could automatically add relevant labels. Might also be nice to create a "Needs Triage" label to also add if we want to do this.