PR & Release Notes

[TurboGit]

I think it is time for this move. We have more and more PR coming. My time is limited and checking the missing release notes and find the corresponding PR to remove the corresponding tag is time consuming.

So please, starting now I'd like to have the Release Notes as part of the PR. If unsure if a release notes is needed or not do not hesitate to push the PR and discuss this with me. Also starting from now I'll add the tag "release notes: pending" on issues if I feel one is needed.

So I'll now merge new PRs only if it has a release notes entry. TIA.

For visibility: @victoryforce @andriiryzhkov @jenshannoschwalm @dennyd @sjuxax @rtmongold @Arecsu @jeffc

[zisoft]

Do you want the release notes entry as a comment "Release notes: bla..." or a direct edit of the RELEASE_NOTES.md as part of the PR?

[andriiryzhkov]

Maybe direct edit of the RELEASE_NOTES.md will actually reduce load. I'd suggest it as a separate commit in the PR, if it is a good idea.

[TurboGit]

Do you want the release notes entry as a comment "Release notes: bla..." or a direct edit of the RELEASE_NOTES.md as part of the PR?

A change in RELEASE_NOTES.md if possible.

[andriiryzhkov]

I will add this requirement to the AGENTS.md too.

[anoderay]

@TurboGit would you like to keep tagging "documentation pending" yourself? I could deal with this if you wanted.

[anoderay]

Additional thought: Would it be possible to create a PR-template similar to (but less extensive then) the Issue-template? That could serve to remind submitters to think about Release Notes and documentation.

[TurboGit]

@TurboGit would you like to keep tagging "documentation pending" yourself? I could deal with this if you wanted.

I want to share this work as I may miss some. So do not hesitate to add the label if needed.

[TurboGit]

Additional thought: Would it be possible to create a PR-template similar to (but less extensive then) the Issue-template? That could serve to remind submitters to think about Release Notes and documentation.

Can we create PR template? I don't know how to do that.

[anoderay]

1.) do you want the tag only to be added once merged or is it okay before?
2.) I've read up on it. A PULL_REQUEST_TEMPLATE.md inside .github/ should to the trick.

[TurboGit]

As now I do request a release notes entry and that every one add it at the end of the list I get quite some conflict resolutions.

So I ask you for some creativity and add the release note not necessary at the end, choose a place at the start, in the middle or at the end but not always at the end. This will avoid most conflicts and the order is not important at all.

[zisoft]

Do you prefer a separate commit for the RELEASE_NOTES.md change?

[anoderay]

@TurboGit draft for a hopefully non-annoying pr-template if you want:

Thanks for your contribution!

Some reminders:
* Describe the Issue your PR aims to solve, provide screenshots etc.
* Include necessary release notes by also pushing to `release_notes.md`. If you are unsure whether release notes are necessary include a draft anyway. 
* Please disclose use of AI