Skip to content

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
wants to merge 1 commit into from

Conversation

jschendel
Copy link
Member

I recall this being mentioned on one of the core dev calls a few months back, and took inspiration from rapidsai/cudf for the various templates.

Added templates for the following use cases:

  • Bug Report
    • This is largely the same as the current issue template
  • Documentation Enhancement
  • Documentation Error
  • Feature Request
  • Submit Question
    • This attempts to direct users to StackOverflow for usage questions

We could also add a Blank Template for opening an issue without any template provided, but opted not to do that for now, as I don't want to encourage people to bypass these templates. Could certainly add one if there's a consensus that we want this.

I've created a local repo where you can see these templates in action since I couldn't figure out another way to actually display these. Click the "New Issue" button to see what these changes would look like.

cc @pandas-dev/pandas-core @pandas-dev/pandas-triage

@jschendel jschendel added the Admin Administrative tasks related to the pandas project label Feb 1, 2020
@jschendel jschendel added this to the 1.1 milestone Feb 1, 2020
name: Bug Report
about: Create a bug report to help us improve pandas
title: "BUG:"
labels: ""
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'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.

@WillAyd
Copy link
Member

WillAyd commented Feb 1, 2020

Nice idea. I think should consolidate the two Documentation templates into one. Also is there a way to just disallow submission of Usage Questions, instead just guiding people to the proper channel for those?

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Feb 3, 2020

A few comments:

  1. I agree with @WillAyd about merging the two documentation ones
  2. On the documentation bug report, you say to indicate the line number, but most people reading the docs won't be looking at the source, so I don't think we should ask for line numbers. Maybe relevant section name.
  3. I think we should give some guidance about how to include the python code. It's never been clear to me whether it is better to include the input/output from an ipython session or from a regular python session.

@WillAyd
Copy link
Member

WillAyd commented Feb 26, 2020

@jschendel still active?

@WillAyd
Copy link
Member

WillAyd commented Mar 11, 2020

Closing as I think stale, but can reopen if something you want to pick up later

@WillAyd WillAyd closed this Mar 11, 2020
@ShaharNaveh
Copy link
Member

@jschendel Do you mind if I revive this PR?

@jschendel
Copy link
Member Author

@MomIsBestFriend : sure, go for it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Administrative tasks related to the pandas project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants