Spot on. This also reminds me that we can create custom issue forms by adding YAML form definition files [1], which is more user-friendly and easy to maintain.
[1] https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#about-yaml-syntax-for-issue-forms On Tue, Dec 14, 2021 at 2:25 AM Michael Marshall <mmarsh...@apache.org> wrote: > +1 Yu, thank you for putting together this thorough document. This is > a great initiative. > > I think it might help to review and possibly update the PR template as > part of this PIP. For example, the current template does not prompt > authors whether the PR should be mentioned in release notes. Such a > prompt could help committers determine the right labels for a PR. > > Thanks, > Michael > > On Mon, Dec 13, 2021 at 4:56 AM Li Li <l...@streamnative.io.invalid> wrote: > > > > +1 > > > > Good idea, I think I can be part of this PIP after I finished upgrading > pulsar website. > > > > Thanks, > > LiLi > > > > > On Dec 13, 2021, at 4:18 PM, Yu <li...@apache.org> wrote: > > > > > > Hi Pulsarers, > > > > > > As we know[1], there are some issues in the current Pulsar release > notes > > > (RN), for example: > > > > > > - For Pulsar users > > > They cannot capture the highlights quickly since the RN is a raw dump > of > > > PRs. > > > > > > - For Pulsar release managers (RM) > > > They feel overwhelmed by the **manual** workload of generating RN > since it > > > is created based on git commit messages, while many people do not > provide > > > clear and meaningful info. > > > It’s time-consuming to clear up all info especially for a major release > > > with lots of PRs. > > > > > > If RN is regarded as an afterthought and finished as a last-minute > task, it > > > is likely not written well. > > > Instead of rushing, treating RN as a part of development not only > reduces > > > RM's workload and makes communication more coordinated, > > > but also allows more time for us to choose the most valuable highlights > > > shown to users. > > > Consequently, the process of the current workflow should be improved. > > > > > > Therefore, I propose the PIP 112: Generate Release Notes Automatically > [2] > > > and add some initial thoughts and research there. > > > It is only a draft but I would like to invite you to join us to bring > > > another major change to Pulsar. I believe this would bring many > benefits to > > > all of us, thanks! > > > > > > [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z > > > [2] > > > > https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically > > >
