On Thu, Feb 2, 2023 at 2:05 AM Henry Wang <henry.w...@arm.com> wrote:
> Hi George, > > > > > From: George Dunlap <george.dun...@cloud.com> > > > Subject: Re: [PATCH] Changelog: Add details about new features for SPR > > > > > > One approach would be to have someone / something (either the release > manager, or an automated script) > > > > An automated script would be best if possible IMHO, as the email > > content would be pretty much fixed/predictable and the email is > > sent periodically. > > > > > periodically (monthly? Bi-weekly?) email each maintainer a list of the > commits under their remit, with an encouragement to consider what entries > could be added to CHANGELOG.md. i.e., something like this: > > > > > > 8<--- > > > Dear $MAINTAINER_NAME, > > > > > > During the last $TIME_PERIOD, the commits below have been checked into > the tree which modify code under your maintainership. Please ensure that > necessary changes to CHANGELOG.md have also been comitted. > > > > > > Thanks, > > > $SENDER > > > > > > $GIT_LOG > > > ---->8 > > > > > > Ideally this would prompt maintainers to get into the habit of always > asking for CHANGELOG entries to be added during review (which would also > get developers into the habit of always including them); at which point the > maintainers could just skim the commits in the email and only add he odd > CHANGELOG that they may have forgotten. > > > > > > Thoughts? > > > > I like this idea very much :) Just a small question: As a developer, it is > > not really clear to me that under what criteria would a patch/series > > deserve for a changelog entry. Personally I would try to include the > > CHANGELOG into my changes in the future if this criteria is cleared. > What I would personally like to see is something that can create a document like this: https://go.dev/doc/go1.20 I'm not sure exactly how to quantify that level of description; nor exactly what other people have in mind. -George >
