Skip to content

refactor: bug report template - #2425

Merged
sirosen merged 8 commits into
jazzband:mainfrom
psthindal:pst-refactor-bug-report-template
Jul 29, 2026
Merged

refactor: bug report template#2425
sirosen merged 8 commits into
jazzband:mainfrom
psthindal:pst-refactor-bug-report-template

Conversation

@psthindal

@psthindal psthindal commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Updated the bug report template to allow for better reporting of bugs.
No tests needed.

Contributor checklist
  • Included tests for the changes.
  • A change note is created in changelog.d/ (see changelog.d/README.md
    for instructions) or the PR text says "no changelog needed".
Maintainer checklist
  • If no changelog is needed, apply the bot:chronographer:skip label.
  • Assign the PR to an existing or new milestone for the target version
    (following Semantic Versioning).

@psthindal
psthindal requested a review from a team as a code owner July 22, 2026 15:06
@psf-chronographer psf-chronographer Bot added the bot:chronographer:provided A mark meaning that a new change log entry is present within the patch. label Jul 22, 2026
@psthindal psthindal changed the title refactor: bug template issue refactor: bug report template Jul 22, 2026
@sirosen sirosen added this to the 7.6.1 milestone Jul 24, 2026

@sirosen sirosen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks so much for getting this moving!
I spotted some minor edits needed, which I've posted as inline suggestions.


I was trying to think how to test the work, and what I came up with was

  • dust off one of my old "junk" repos
  • add the template there
  • keep pushing amended commits until it looks right
  • come back here with feedback

You can see it here: sirosen/gah@e75b9f6

Comment thread .github/ISSUE_TEMPLATE/bug-report.md Outdated
Comment thread .github/ISSUE_TEMPLATE/bug-report.md Outdated
Comment thread .github/ISSUE_TEMPLATE/bug-report.md Outdated
Comment thread .github/ISSUE_TEMPLATE/bug-report.md Outdated
Comment thread changelog.d/+3148a12a.contrib.md Outdated
Comment thread .github/ISSUE_TEMPLATE/bug-report.md Outdated
@psthindal

Copy link
Copy Markdown
Contributor Author

Thanks for your comments. Ive briefly had a look at them and they seem sensible to me. I'll try and take a proper look tomorrow when I have some free time, and provide some comprehensive comments/replies. Cheers!

@psthindal

psthindal commented Jul 26, 2026

Copy link
Copy Markdown
Contributor Author

Evening! I've taken on board your comments and made the suggested changes in commit 2003511.

The main point I think still needs clarifying is the validations addition in the bug template, which I've outlined in my earlier comment.

Would you mind taking a look to see if my understanding is correct?

As always, any feedback is welcome. Cheers!

@sirosen sirosen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks so much for working through all the details on this! I have one very minor tweak we should apply, I think, but overall this is ready to go. 🚀

We're not running yamllint today. I thought we were, but I poked around and realized it's missing. Maybe we had planned to add it and never did.

Comment thread .github/ISSUE_TEMPLATE/bug-report.yaml Outdated
@sirosen
sirosen enabled auto-merge July 29, 2026 14:45
@sirosen
sirosen added this pull request to the merge queue Jul 29, 2026
Merged via the queue into jazzband:main with commit e7f9099 Jul 29, 2026
75 checks passed
@psthindal

Copy link
Copy Markdown
Contributor Author

Thanks for approving and merging.

We're not running yamllint today. I thought we were, but I poked around and realized it's missing. Maybe we had planned to add it and never did.

Do you want me to add this in, in a seperate PR?

@psthindal
psthindal deleted the pst-refactor-bug-report-template branch July 30, 2026 03:30
@webknjaz

Copy link
Copy Markdown
Member

@psthindal yes plz. Try duplicating the config from https://github.com/tox-dev/tox-towncrier/blob/0e046a27cd368bda86a72308889601ba3737b157/.pre-commit-config.yaml#L138-L146 + https://github.com/tox-dev/tox-towncrier/blob/0e046a27cd368bda86a72308889601ba3737b157/.yamllint

The way I do it is I normally have multiple repos cloned on my laptop like so

$ git clone git@github.com:tox-dev/tox-towncrier.git ~/src/github/tox-dev/tox-towncrier
$ git clone git@github.com:jazzband/pip-tools.git ~/src/github/jazzband/pip-tools

And with that, it's possible to either copy individual configs as is

$ cp -v ~/src/github/tox-dev/tox-towncrier/.yamllint ~/src/github/jazzband/pip-tools/

or open them in a favorite editor if they're partially there and there's a need to drag bits of another project in-between the existing sections preserving the order and the config shape across projects

$ nvim -d ~/src/github/tox-dev/tox-towncrier/.pre-commit-config.yaml ~/src/github/jazzband/pip-tools/.pre-commit-config.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:provided A mark meaning that a new change log entry is present within the patch.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants