-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
ADMIN: Create separate issue templates for different usecases #33187
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 all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
c06f29c
ADMIN: Create separate issue templates for different usecases
jschendel 1a3b03d
Merge two documentation templates
cb13d8e
Merge remote-tracking branch 'upstream/master' into issue-template
3956ae1
Moved guide for minimial example before the Code sample section
68a8cbc
Using checkboxes in the bug report
61fdf40
Newline nits
fe66538
Encouraging users to supply URL of problematic documentation
b9ead18
Renamed "wrong_or_missing_documentation" to "documentation_improvement"
7f5ae95
Encouraging users to write a docstring for desired feature
7fb0a81
Added "API breaking implications" header
3ac643e
Update .github/ISSUE_TEMPLATE/bug_report.md
ShaharNaveh cd4565a
Update .github/ISSUE_TEMPLATE/documentation_improvement.md
ShaharNaveh ebbf55e
Replaced notes with checkboxes
842f8da
Fixed typos/grammer mistakes
413d30a
Merge remote-tracking branch 'upstream/master' into issue-template
8c891f3
Add labels to each issue template
9bf7738
Added "Needs Triage" label to all templates
d7cbd30
Merge remote-tracking branch 'upstream/master' into issue-template
5f9040c
Update .github/ISSUE_TEMPLATE/submit_question.md
ShaharNaveh 3fb35c4
Update .github/ISSUE_TEMPLATE/submit_question.md
ShaharNaveh 72ccc0f
Merge remote-tracking branch 'upstream/master' into issue-template
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
This file was deleted.
Oops, something went wrong.
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,39 @@ | ||
--- | ||
|
||
name: Bug Report | ||
about: Create a bug report to help us improve pandas | ||
title: "BUG:" | ||
labels: "Bug, Needs Triage" | ||
|
||
--- | ||
|
||
- [ ] I have checked that this issue has not already been reported. | ||
|
||
- [ ] I have confirmed this bug exists on the latest version of pandas. | ||
|
||
- [ ] (optional) I have confirmed this bug exists on the master branch of pandas. | ||
|
||
--- | ||
|
||
**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. | ||
|
||
#### Code Sample, a copy-pastable example | ||
|
||
```python | ||
# Your code here | ||
|
||
``` | ||
|
||
#### Problem description | ||
|
||
[this should explain **why** the current behaviour is a problem and why the expected output is a better solution] | ||
|
||
#### Expected Output | ||
|
||
#### Output of ``pd.show_versions()`` | ||
|
||
<details> | ||
|
||
[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,22 @@ | ||
--- | ||
|
||
name: Documentation Improvement | ||
about: Report wrong or missing documentation | ||
title: "DOC:" | ||
labels: "Docs, Needs Triage" | ||
|
||
--- | ||
|
||
#### Location of the documentation | ||
|
||
[this should provide the location of the documentation, e.g. "pandas.read_csv" or the URL of the documentation, e.g. "https://dev.pandas.io/docs/reference/api/pandas.read_csv.html"] | ||
|
||
**Note**: You can check the latest versions of the docs on `master` [here](https://dev.pandas.io/docs). | ||
|
||
#### Documentation problem | ||
|
||
[this should provide a description of what documentation you believe needs to be fixed/improved] | ||
|
||
#### Suggested fix for documentation | ||
|
||
[this should explain the suggested fix and **why** it's better than the existing documentation] |
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,33 @@ | ||
--- | ||
|
||
name: Feature Request | ||
about: Suggest an idea for pandas | ||
title: "ENH:" | ||
labels: "Enhancement, Needs Triage" | ||
|
||
--- | ||
|
||
#### 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 [...]", try to write a docstring for the desired feature] | ||
|
||
#### API breaking implications | ||
|
||
[this should provide a description of how this feature will affect the API] | ||
|
||
TomAugspurger marked this conversation as resolved.
Show resolved
Hide resolved
|
||
#### 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,24 @@ | ||
--- | ||
|
||
name: Submit Question | ||
about: Ask a general question about pandas | ||
title: "QST:" | ||
labels: "Usage Question, Needs Triage" | ||
|
||
--- | ||
|
||
- [ ] I have searched the [[pandas] tag](https://stackoverflow.com/questions/tagged/pandas) on StackOverflow for similar questions. | ||
|
||
- [ ] I have asked my usage related question on [StackOverflow](https://stackoverflow.com). | ||
|
||
--- | ||
|
||
#### Question about pandas | ||
|
||
**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.
Uh oh!
There was an error while loading. Please reload this page.