Skip to content
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

DOC: Clean up instructions in ISSUE_TEMPLATE #17146

Merged
merged 1 commit into from
Aug 1, 2017
Merged

DOC: Clean up instructions in ISSUE_TEMPLATE #17146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,18 @@

[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

Choose a reason for hiding this comment

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

you can put those notes in a comment, so if people don't remove it, it at least doesn't show up in the rendered issue

it's like (from sklearn template)

<!--
If your issue is a usage question, submit it here instead:
- StackOverflow with the scikit-learn tag: http://stackoverflow.com/questions/tagged/scikit-learn
- Mailing List: https://mail.python.org/mailman/listinfo/scikit-learn
For more information, see User Questions: http://scikit-learn.org/stable/support.html#user-questions
-->

Copy link
Member

Choose a reason for hiding this comment

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

actually, that content is maybe also useful to add :-)

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we've generally handled usage questions on the issue tracker from time-to-time.

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've generally handled usage questions on the issue tracker from time-to-time.

Yes, but that is not the purpose of the github issue tracker, and give only clutter (that said, I am very well aware it is not avoidable to a certain extent, but giving those pointers might help)


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

Choose a reason for hiding this comment

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

I personally would leave out this one. It is fully correct, but we have to be aware that the longer the text in here, the less people will read it. I would rather put it in our contributing docs and clearly link to that as a guide on how to submit an issue

Copy link
Member Author

Choose a reason for hiding this comment

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

@jorisvandenbossche : But following your logic, people are not very likely to read the contributing docs when it comes to submitting issues. That's why I put that note here.


Copy link
Member Author

Choose a reason for hiding this comment

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

I currently have added some points as "notes" to the issue template, but I was also considering make them check-boxes (similar to what we have in the PR template). Which one do you think is better?

Copy link
Contributor

Choose a reason for hiding this comment

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

hah just actually read your comment again (after merging of course). this is fine.

#### Expected Output

#### Output of ``pd.show_versions()``

<details>
# Paste the output here pd.show_versions() here

[paste the output of ``pd.show_versions()`` here below this line]
Copy link
Member Author

@gfyoung gfyoung Aug 1, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

A lot of people were just posting the output right below the "details" tag, causing it to not render properly. This is an effort to guide people away from doing that.


</details>