Documenting Commits

[Doug Smythies]

On 2013.09.20 14:36 Little Girl wrote:

> Doug Smythies wrote:

>> I'll cut and paste my reply to the same off-list message about the
>> changelog:
> 
>> Hi Benjamin,
>> 
>> It is not an oversight [that I have not been updating the
>> changelog].
>> 
>> I had thought it was the generally accepted practice for this
>> project.
>> 
>> My understanding, from a few e-mails on the doc-list history, is
>> that we do not do the changelog stuff for the day to day edits
>> during the cycle. And this is also why the changelog stuff was
>> deleted from that getting started page. The changelog stuff is done
>> during the .pot .po cycle just at doc string freeze (reference
>> Jeremy Bicha 2013.04.14 13:17 (my time)).

> So how did this turn out? Do we do the 'dch -i' and 'debcommit' or
> not? Not that we can push anything right now anyway, but it's always
> nice to know what the rules are. (:

I don't think we drove this one to an overall consensus (we had some
off-list exchange also).

There is consensus on:

. The changelog must be updated when the package version of the
Desktop help docs is going to be updated from the not packaged version.
This would be a documentation committer requirement, and not of concern
to documentation contributors.

. The changelog does not have to be updated for every single commit.

There is not consensus on:

. The frequency that the changelog should be updated in the not
packaged version.

Regardless, I consider this issue to be a documentation committer
issue and not something a documentation contributor needs to
worry about. (Which is why, as mentioned above, we removed the
changelog stuff from that new "getting started" page.)