Better release notes

[Siddharth Agarwal]

On 2/2/17 10:53, Gregory Szorc wrote:
> * Checking in a dedicated file tracking release notes and starting a 
> culture where we update this file accordingly (many open source 
> projects do this)

This is a good idea. +1 for a changelog file that explicitly only 
contains user-facing release notes.

> * Adding special syntax to commit messages to facilitate release notes 
> auto generation. This would have to support multi-line notes for 
> detailed descriptions. This is like what we do today except in my head 
> I think the notes would be derived not from the summary line but from 
> special syntax elsewhere. We could enforce that certain commit 
> messages have certain syntax. e.g. a "(BC)" message would require a 
> special section detailing what the compatibility change is. We could 
> also e.g. introduce a "(FEATURE)" in the summary line that indicates a 
> new feature and requires syntax to describe a user story, how to use 
> it, etc.

Commit messages are immutable and hard to copy-edit once they're in the 
repo, so -1 on this.

>
> Thoughts?
>
>
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel at mercurial-scm.org
> https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel