Anonymitaet edited a comment on pull request #12425:
URL: https://github.com/apache/pulsar/pull/12425#issuecomment-984419496


   > I have removed "PIP-89"
   > 
   > This is really a list of "Commit messages". I am not sure it is worth to 
change them so much.
   > 
   > The spirit of this page **currently** is to report the PRs, if change the 
titles to much there will be no good match.
   > 
   > I believe that we should create a new way of creating the release notes
   
   A good release note is a clear and concise summary of changes rather than a 
copy of all commit messages, which means each PR and its description should be 
checked carefully. If a PR title is not good enough, in the release note, we 
can re-write the PR title to make it more accurate and readable. No need to 
worry about the "different titles" since the PR link is added at the end. Users 
can know the details if they want.
   
   Besides, the consistent format is the basic requirement for a release note.
   I check this several times, but find that the following contents are still 
in inconsistent formats:
   - Cases (upper case, lower case)
   - Links, eg. PIP XX, PIP-XX, `[#XXXX](xxx)`, `[XXXX](xxx)`
   Below are just some examples, can you check them all? 
   
![image](https://user-images.githubusercontent.com/50226895/144387360-1410514f-8f02-43ff-badc-fc66fe1c231c.png)
   
![image](https://user-images.githubusercontent.com/50226895/144387716-e5892824-b55f-418f-8ab9-17cd324a1455.png)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to