Skip to content

Conversation

@VeckoTheGecko
Copy link
Contributor

@VeckoTheGecko VeckoTheGecko commented Feb 11, 2025

This PR template will be the default in the text box when creating a pull request. I thought a simple checklist would be helpful (notably the choosing the correct base branch reminder).

<!-- Feel free to remove list items that are not relevant for your changes. -->

- [ ] Chose the correct base branch (`main` for v3 changes, `v4-dev` for v4 changes)
- [ ] Fixes #
- [ ] Added tests
- [ ] Added documentation

Copy link
Member

@erikvansebille erikvansebille left a comment

Choose a reason for hiding this comment

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

Good idea! Is it also an idea to add a checkbox whether this is a PR that should be highlighted in the release notes? Is there an easy workflow then to find the PRs in the list that have this checked? Or is that over-engineering?

@VeckoTheGecko
Copy link
Contributor Author

VeckoTheGecko commented Feb 11, 2025

Is there an easy workflow then to find the PRs in the list that have this checked?

We can have a PR label for items that are "important changes" that we want to have in their own section in the release notes. This is supported by the configuration Github uses for generating the release notes.

Or is that over-engineering?

I think so. I think having the mental overhead on a PR level would, in total, be more than curating the notes during release. I think this would really be helpful in larger projects with many contributors.

@VeckoTheGecko VeckoTheGecko merged commit 0b4906a into main Feb 14, 2025
16 checks passed
@VeckoTheGecko VeckoTheGecko deleted the v/pr-message branch February 14, 2025 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants