I really like (2). Yes it is work to link each PR to a Jira. But it really helps users understand what they are getting. The Jira can contain the necessary context.
Spark does this well: https://github.com/apache/spark/commits/master Madan > On Nov 9, 2017, at 2:43 PM, Meghna Baijal <meghnabaijal2...@gmail.com> wrote: > > Hello All, > > Currently, there is no process in place to identify the new features that > go into every release. All the commits since the previous release are > manually parsed to find the important changes that go into the release > notes. > > > In order to improve this process, I want to start a discussion on the > following options - > > 1. *Better PR titles* - if possible, these should be good enough to be > picked as is into the release notes. > > 2. *JIRA Issues* - each commit should be tagged with an associated JIRA > issue. This issue should describe the problem. JIRA tickets can be used to > automate the generation of release notes. > > 3. *Adding Labels to the PRs/Commits* - There can be a set of 3-5 labels > such as ‘Bug-Fix’, ‘New Feature’, ‘Docs’, ‘Minor Change’ etc. Atleast those > PRs which are important and should be included in the release notes should > be labeled. > However, labels can only be added by those with write access to the repo. > So the committers will have to triage this label addition as they > review/merge the PRs. > > > Do you think these changes are feasible? Will they help? What other options > should be considered? > > Thanks, > Meghna Baijal
