Skip to content

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.

Sign up for GitHub

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 21 commits into from
Apr 3, 2020
Merged

ADMIN: Create separate issue templates for different usecases #33187

Show file tree
Hide file tree
Changes from 2 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 Feb 1, 2020
1a3b03d
Merge two documentation templates
Mar 31, 2020
cb13d8e
Merge remote-tracking branch 'upstream/master' into issue-template
Apr 1, 2020
3956ae1
Moved guide for minimial example before the Code sample section
Apr 1, 2020
68a8cbc
Using checkboxes in the bug report
Apr 1, 2020
61fdf40
Newline nits
Apr 1, 2020
fe66538
Encouraging users to supply URL of problematic documentation
Apr 1, 2020
b9ead18
Renamed "wrong_or_missing_documentation" to "documentation_improvement"
Apr 1, 2020
7f5ae95
Encouraging users to write a docstring for desired feature
Apr 1, 2020
7fb0a81
Added "API breaking implications" header
Apr 1, 2020
3ac643e
Update .github/ISSUE_TEMPLATE/bug_report.md
ShaharNaveh Apr 1, 2020
cd4565a
Update .github/ISSUE_TEMPLATE/documentation_improvement.md
ShaharNaveh Apr 1, 2020
ebbf55e
Replaced notes with checkboxes
Apr 1, 2020
842f8da
Fixed typos/grammer mistakes
Apr 1, 2020
413d30a
Merge remote-tracking branch 'upstream/master' into issue-template
Apr 1, 2020
8c891f3
Add labels to each issue template
Apr 1, 2020
9bf7738
Added "Needs Triage" label to all templates
Apr 1, 2020
d7cbd30
Merge remote-tracking branch 'upstream/master' into issue-template
Apr 1, 2020
5f9040c
Update .github/ISSUE_TEMPLATE/submit_question.md
ShaharNaveh Apr 2, 2020
3fb35c4
Update .github/ISSUE_TEMPLATE/submit_question.md
ShaharNaveh Apr 2, 2020
72ccc0f
Merge remote-tracking branch 'upstream/master' into issue-template
Apr 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions .github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
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: ""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say we should use this label: feature to automatically tag the issue with the appropriate label. For this template Bug and similarly for the others.

https://i.8713187.xyzmunity/t5/How-to-use-Git-and-GitHub/Apply-labels-automatically-at-issue-creation/td-p/10719#

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just making sure before I make the changes, the labels for each file should look like this:

bug_report: Bug

documentation_improvement: Docs

feature_request: Enhancement?

submit_question: "Usage Question"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was originally on the fence about automatically adding labels because it could make it harder to distinguish what has been triaged vs. what hasn't, since I currently look for the presence of labels to determine if something has been triaged, and automatically adding labels would make it less clear whether a triage has occurred or not.

A potential workaround here is to also automatically add a new "Needs Triage" label and then remove it as part of the triage process. Or maybe this is only an issue on my part, in which case I can work around it.

Copy link
Member Author

@ShaharNaveh ShaharNaveh Apr 1, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feature_request: Enhancement?

We don't have a label for feature requests

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have a label for feature requests

We typically use the "Enhancement" label for this, so I think what you've proposed above is good.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I've seen a couple variants of this: rapidsai/cudf automatically adds a generic "? - Needs Triage" label, scikit-learn/scikit-learn adds a "Bug: triage" just to bug reports.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Numba has a need triage label: https://github.com/numba/numba/issues?q=is%3Aissue+is%3Aopen+label%3Aneedtriage

I'd be in favor in autotagging with <Bug/Doc/Enhancement/...> + Need Traige, and then Need Triage can be removed once someone has commented (and can be replace with a more specific label like IO CSV for example)

I've also been making an effort to tag older issue with one of Bug/Doc/Enhancement/... which will be useful in the future for developing metrics about total number of issues per category.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mroeschke ATM Need Triage label does not exists.
Should I wait for it to be created? or just edit this pull request to auto-assign the label Need Triage and the label will be created later.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went ahead and just created a Needs Triage label so it should be available now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @mroeschke


---

#### 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, this should go before the Code Sample


#### 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!
Copy link
Member

@mroeschke mroeschke Mar 31, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a suggestion. I think we should change these two **Note** sections into checkboxes like

- [ ] I have checked that issue has not already been reported
- [ ] I have confirmed this bug exists on the latest version of pandas
- [ ] I have confirmed this bug exists on the master branch of pandas

More succinct than these sections IMO.

Inspired how Numba does their bug reports: numba/numba#4735


**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>
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
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 [...]"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've found asking people to "write a docstring" to be helpful in clarifying what people are asking for.


#### 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

```
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/submit_question.md
View file
Open in desktop
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

```
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/wrong_or_missing_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Documentation Improvment
about: Report wrong or missing documentation
title: "DOC:"
labels: ""

---

#### Location of the documentation

[this should provide a description of what documentation you believe needs to be fixed/improved]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also encourage a link to the documentation that they want to see improved.


**Note**: You can check the latest versions of the docs on `master` [here](https://dev.pandas.io/docs).

[this should provide a clear and concise description of what you want to happen]

#### Suggested fix for documentation

[this should explain the suggested fix and **why** it's better than the existing documentation]