The release-notes and change-logs are autocreated from the merged PRs. That is great but we do not mention this in the PR-Template at all and suggest a structure that needs quite some adjustments before beeing a proper release note.
To make our life easier (especially of future release managers) i suggest to adjust the pr template
slighty and to mention explicitly what the texts will be used for. In addition the checklist is amended with some ticks for the reviewers.
<!-- Thanks for your contribution, we appreciate it! The first section should explain briefly what was changed. Some examples would are always nice to showcase the use. The content will be used in the change-logs and release notes and addresses developers working with Neos. If there are issues regarding the topic of your PR link them here as `related:` or `resolved` --> **Upgrade instructions** <!-- Add upgrade instructions for breaking changes. Explain who is affected, what has to be adjusted --> **Explanations (to be removed after merging)** <!-- If your change is not explained fully by the first section you can add more details here to help the reviewers understand the change. We have to understand what you did, why you did it and how we can verify it works correctly and does no harm. --> **Checklist (to be removed after merging)** - [ ] Code follows the PSR-2 coding style - [ ] Tests have been created, run and adjusted as needed - [ ] The PR is created against the [lowest maintained branch](https://www.neos.io/features/release-roadmap.html) - [ ] Reviewer - PR Title is brief but complete and starts with `FEATURE|TASK|BUGFIX` - [ ] Reviewer - The first section explains the change briefly for change-logs - [ ] Reviewer - Breaking Changes are marked wit `!!!` and have upgrade-instructions
For issues i suggest to get away from the “always an issue alongside a pr” rule (at least as long as we generate the change logs from prs) and use those for things that cannot be adjusted right away because they need discussion or no solution can be provided yet.
<!-- Thanks for your contribution, we appreciate it! Issues are for keeping track of things that cannot be adjusted immediately. Either because there is no solution yet, the solution will have to wait for a while or the topic needs some discussion beforehand. If you already have a solution you can create a pull request directly. Please also take the time and try to avoid reporting duplicates by searching for existing issues in the issue-list. --> ### Description <!-- Please describe the bug or feature briefly. Try to avoid beeing specific about the solution as there may be more options available. --> ### Steps to Reproduce <!-- To understand your problem faster we need a description how the issue can be reproduced. Please be as specific as possible here, this helps us to solving issues faster. Issues that cannot be reproduced are hardly ever fixed. Please include the observed behavior and the expected behavior in your description. --> ### Affected Versions <!-- If you report a bug add the versions of Flow and Neos that you are using. If you want to be a super-hero, try to find out the oldest supported version affected by the bug you describe. Thanks! -->