[GitHub] [logging-log4j2] vy commented on pull request #1266: Improves changelog template

["vy (via GitHub)" <gi...@apache.org>]

vy commented on PR #1266:
URL: https://github.com/apache/logging-log4j2/pull/1266#issuecomment-1421371009

   ## Before
   
   ![image](https://user-images.githubusercontent.com/72137/217349566-00cfd83b-c705-4948-9d39-deaf75676a23.png)
   
   ## After
   
   ![image](https://user-images.githubusercontent.com/72137/217349657-a7d5aa8c-25fa-458d-98f5-154335ea5393.png)
   
   Note that I needed to adopt the changelog-type headers to match the fix I have pushed earlier today.
   
   ## Feedback
   
   I don't agree with this change for the following reasons.
   
   * A brief summary of the change should come first, that is what matters most, not the ticket ID. Many projects (Keep-a-Changelog, Spring, etc.) follow this convention.
   * When a change is associated with multiple tickets, the reading flow will be broken since ticket IDs prefix the entry.
   * Why would anybody want to see an ID instead of the actual name?
   * I am strictly against author types; committer, reviewer, triage professional, reporter, etc. For one, it is a trap to come up with an exhaustive list, because nobody cares. The names are there simply to get the credits right. Those who are interested in who did what, can simply click on the ticket linked.
   * The current version reads natively, i.e., _"<description> (for <ticket> by <author>)"_, whereas the new one doesn't. That is, the readability is degraded, in particular, given both almost occupy the screen real estate.


-- 
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: notifications-unsubscribe@logging.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org