[bind10-dev] Changes Log

[Shane Kerr]

Jinmei,

On Mon, 2010-05-10 at 19:00 -0700, JINMEI Tatuya / 神明達哉 wrote:
> This is similar to BIND 9's CHANGES entry, but is different in the
> following points:
> 
> - it has the corresponding svn changeset (to trunk).  this may not
>   always be feasible, so I'd consider this optional.

Agreed, but good to have around when possible. Presumably this is
straightforward to convert to a Mercurial/git/${DVCS} commit identifier
when we convert to such a thing.

> - it shows the developer committing to the change.  I'm not
>   necessarily pushing this style, but thought it might be better in
>   that we give clear credit to the contribution, especially because
>   BIND 10 is (and will be hopefully) multi organization effort,
>   perhaps also with individual committers in future.

I think this is nice.

We may also want to think about how we give credit to people who report
or otherwise help us fix problems, but don't actually commit them. A
common example would be someone who submits a patch but we need to
re-implement it in a more careful way (a common fate for patches I send
to various projects). In DHCP we tend to say something like "thanks to
Fred Flintstone <fflint at bedrock.net> for reporting the bug", but that
may be a bit too verbose for this format....

> - it shows a brief legend of change "categories".
> 
> The description of the change is not very detailed as the DHCP-style
> example.  In fact, the DHCP ones are "release notes", rather than a
> mere "log of changes".  I tend to agree that it's nice to provide a
> more readable release note containing details of major changes (BIND
> 9's release notes are not very good in this sense), but I think it
> makes sense to have a relatively concise list of changes.  So, in the
> above proposal I tried to avoid being too detailed.

Okay, seems reasonable.

> I know the overhead may become an issue if we try to provide both this
> style of change logs and more detailed release notes.  If it turns out
> to be the case we may consider consolidating those.

Agreed.

> Comments?  (Can I commit this experimental entry to trunk?)

I have no objections. :)

--
Shane