Hi Lari, Thanks for your suggestions!
> In Git, the convention is to have a subject line (title) with no more than 50 characters. When you start adding all kinds of tags in brackets in the title, there won't be much left for the actual content. I think the guideline does not conflict with Git message conventions because: 1) [tags in brackets] occupy some space but they provide more value. 1a) It makes everyone know the PR changes at a quick glance. You can get a general idea by just reading the beginning brackets. 1b) It's a reminder that every contributor should be an efficient collaborator by summarizing your changes clearly and making PR titles self-explanatory and informative. 2) 50 characters is not a hard limit, just a rule of thumb. GitHub’s UI truncates any subject line longer than 72 characters with an ellipsis, which means you have enough length to explain your PR changes. If you’re having a hard time summarizing, you might be committing too many changes at once. Strive for atomic commits (a topic for a separate post). On Thu, Mar 24, 2022 at 3:06 PM Lari Hotari <lhot...@apache.org> wrote: > The problem with the "Pulsar PR Naming Convention" is that it can conflict > with general Git message conventions. > > The PR title automatically becomes the Git commit's subject line. That's > how the PR title related to the Git commit's subject line (title). > > In Git, the convention is to have a subject line (title) with no more than > 50 characters. When you start adding all kinds of tags in brackets in the > title, there won't be much left for the actual content. > > For example, GitHub's UI suggests to write commit messages that are less > than 50 characters. There's more explanation about the "Limit the subject > line to 50 characters" rule in Chris Beam's awesome "How to Write a Git > Commit Message" blog post: https://cbea.ms/git-commit/#limit-50 > > Do we care about the general rule that a git commit message should be > limited to 50 characters? > > -Lari > > On 2022/03/17 02:11:54 Yu 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 > > >
