#1 Thanks, Penghui, I'll add this guideline link in the contribution guide after we make a consensus.
#2 Based on the suggestions from the community, I've made the following tweaks to make info more clear: - Change "type/enhancement" to "type/improvement" - Change type abbreviation "enh" to "improve", "feat" to "feature" #3 Today when I review Pulsar PRs, I find that many contributors start following this guideline to write PR titles, which is super AWESOME! Thank you all to make the community more productive! Hope more people will join us together! On Fri, Mar 18, 2022 at 3:44 PM PengHui Li <peng...@apache.org> wrote: > It's better to update the contributing guideline, > so that all the new contributors can follow the guidelines > > For the committers, we'd better try to update the PR > title as the guideline before merging it. > > It's not easy to reach a consensus very fast, > but we can finally reach it :) > > Thanks, > Penghui > > On Fri, Mar 18, 2022 at 2:47 PM Yu <li...@apache.org> wrote: > > > Thanks for your suggestions, Penghui, Enrico, and Nicoló Boschi. > > > > Yes, it might be hard to enforce but this is a good start. > > > > Nothing can be accomplished without standards. It is recommended to > follow > > the rules defined in this guide after the community reaches a consensus. > > > > > > On Thu, Mar 17, 2022 at 9:10 PM Enrico Olivelli <eolive...@gmail.com> > > wrote: > > > > > Thank you Yu, > > > I left some feedback on the gdoc > > > > > > Overall it is a great proposal. > > > > > > It will probably be hard to enforce, we will have to spend time and > > > fix the title when we see the wrong title. > > > but I totally agree with you, this effort will help the community in > > > understand better what we are doing (during code reviews) and also > > > what we did (release notes) > > > > > > > > > Enrico > > > > > > Il giorno gio 17 mar 2022 alle ore 03:38 PengHui Li > > > <peng...@apache.org> ha scritto: > > > > > > > > Hi Yu, > > > > > > > > Thanks for the great guidance. > > > > Overall looks good to me, just left a few minor comments. > > > > > > > > Penghui > > > > > > > > On Thu, Mar 17, 2022 at 10:12 AM Yu <li...@apache.org> wrote: > > > >> > > > >> Hi Pulsarers, > > > >> > > > >> We submit or review PRs almost every day, we might see many vague > and > > > unclear PR titles that decrease team efficiency and productivity. > > > >> > > > >> Good PR titles offer bring many benefits, such as speeding up the > > > review process and improving search efficiency. > > > >> > > > >> To solve the vague PR title issue and move *PIP 112: Generate > Release > > > Notes Automatically* [1] forward, I've created *Guideline: Pulsar PR > > Naming > > > Convention* [2], which explains why you need good PR titles and how you > > do > > > that with various self-explanatory examples. Also, Pulsar and client > > > release notes will be generated automatically based on the rules > defined > > in > > > this guide. > > > >> > > > >> Do not hesitate to comment if you have any questions or concerns. > > > Feedback before EOD 3/21 CST is highly appreciated, thanks! > > > >> > > > >> [1] > > > > > > https://docs.google.com/document/d/1Ul2qIChDe8QDlDwJBICq1VviYZhdk1djKJJC5wXAGsI/edit# > > > >> [2] > > > > > > https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit# > > > >> > > > >> Regards, > > > >> Anonymitaet > > > > > >
