refactor: bug report template - #2425
Conversation
sirosen
left a comment
There was a problem hiding this comment.
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
|
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! |
Co-authored-by: Stephen Rosen <sirosen@globus.org>
Co-authored-by: Stephen Rosen <sirosen@globus.org>
Co-authored-by: Stephen Rosen <sirosen@globus.org>
|
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 Would you mind taking a look to see if my understanding is correct? As always, any feedback is welcome. Cheers! |
sirosen
left a comment
There was a problem hiding this comment.
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.
|
Thanks for approving and merging.
Do you want me to add this in, in a seperate PR? |
|
@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-toolsAnd 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 |
Updated the bug report template to allow for better reporting of bugs.
No tests needed.
Contributor checklist
Included tests for the changes.changelog.d/(seechangelog.d/README.mdfor instructions) or the PR text says "no changelog needed".
Maintainer checklist
bot:chronographer:skiplabel.(following Semantic Versioning).