Skip to content

chore: create bug report issue template#454

Merged
rouille merged 1 commit intodevelopfrom
ben/bug_report
Apr 27, 2021
Merged

chore: create bug report issue template#454
rouille merged 1 commit intodevelopfrom
ben/bug_report

Conversation

@rouille
Copy link
Copy Markdown
Collaborator

@rouille rouille commented Apr 20, 2021

This is the automatic Bug Report Issue Template from GitHub. I did not write anything. We can change it. Pandas has a template that is quite nice (see https://github.com/pandas-dev/pandas/issues/new/choose)

@rouille rouille self-assigned this Apr 20, 2021
@rouille rouille marked this pull request as draft April 20, 2021 21:56
Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated
Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated
@rouille
Copy link
Copy Markdown
Collaborator Author

rouille commented Apr 20, 2021

I prefer what pandas came up with:

  • 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 detailing how to provide the necessary information for us to reproduce your bug.

Code Sample, a copy-pastable example

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

@rouille
Copy link
Copy Markdown
Collaborator Author

rouille commented Apr 20, 2021

This is matplotlib:

Bug report

Bug summary

Code for reproduction

# Paste your code here
#
#

Actual outcome

# If applicable, paste the console output here
#
#

Expected outcome

Matplotlib version

  • Operating system:
  • Matplotlib version (import matplotlib; print(matplotlib.__version__)):
  • Matplotlib backend (print(matplotlib.get_backend())):
  • Python version:
  • Jupyter version (if applicable):
  • Other libraries:

@rouille
Copy link
Copy Markdown
Collaborator Author

rouille commented Apr 21, 2021

My only request is to have either (or both)

🐛 or 🪲

in the header of the template

Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm not entirely sure which version this refers to (OS? browser?), but I like the matplotlib version that includes a place for the versions of python, jupyter, other libraries, etc.

@rouille rouille marked this pull request as ready for review April 26, 2021 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants