Skip to content

chore: improve issue template #4276

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
henryiii merged 5 commits into from
Oct 23, 2022
Merged

chore: improve issue template #4276

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b358a1c
chore: improve issue template
henryiii Oct 22, 2022
e8897c5
style: pre-commit fixes
pre-commit-ci[bot] Oct 22, 2022
e8dbf54
Update bug-report.yml
henryiii Oct 22, 2022
0f5bc58
Emphasize that PRs are much more likely to get attention.
rwgk Oct 23, 2022
80ae64a
Fix accident.
rwgk Oct 23, 2022
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
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ body:
attributes:
value: |
Maintainers will only make a best effort to triage PRs. Please do your best to make the issue as easy to act on as possible, and only open if clearly a problem with pybind11 (ask first if unsure).

- type: checkboxes
id: steps
attributes:
Expand All @@ -20,6 +21,12 @@ body:
- label: Consider asking first in the [Gitter chat room](https://gitter.im/pybind/Lobby) or in a [Discussion](https:/pybind/pybind11/discussions/new).
required: false

- type: Input
id: version
attributes:
label: What version (or hash if on master) of pybind11 are you using?
required: true

- type: textarea
id: description
attributes:
Expand All @@ -43,3 +50,10 @@ body:
issue. If possible, make a PR with a new, failing test to give us a
Copy link
Collaborator

@rwgk rwgk Oct 22, 2022

Choose a reason for hiding this comment

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

How about:

In bold near the top: Note that a reproducer in a PR is much more likely to get immediate attention!

Near the top so that people think about their decision bug vs PR immediately.

Then repeat that sentence here, followed by: Failing tests in our CI give us the best starting point for working out fixes.

I could send a PR, plmk.

Copy link
Collaborator Author

@henryiii henryiii Oct 22, 2022

Choose a reason for hiding this comment

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

You can add to this one, I expect?

Copy link
Collaborator

@rwgk rwgk Oct 23, 2022

Choose a reason for hiding this comment

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

Done (0f5bc58).

Copy link
Collaborator

@rwgk rwgk Oct 23, 2022

Choose a reason for hiding this comment

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

Sorry that one had an accident. Fixed.

starting point to work on!
render: text

- type: Input
id: regresssion
attributes:
label: Is this a regression? Put the last known working version here if it is.
description: Put the last known working version here if this is a regression.
value: Not a regression