ubuntu-accomplishments-contributors team mailing list archive

[Gabriel <gepatino@xxxxxxxxx>]

2012/8/3 Jono Bacon <jono@xxxxxxxxxx>

> Hi All,
>
> We didn't decide on a solution to this and now every time I commit I
> feel like I should be taking a smarter changelog somewhere. Would you
> folks be happy if I create a file called LOG in each of the projects
> where we note new features and bugfixes and then we transition this to
> the changelog when we release?
>


I use to have a ChangeLog file in the root directory of all my projects. I
guess I've copied the format some time ago from an open source project, but
I don't remember which one, or if it's a standard.

When opening it with vim, syntax is highlighted, so it shouldn't be such a
weird format.

Some lines for a real life ChangeLog in one of my current projects:

----------------------------------------
Release:    0.15.0
Date:       In Progress

----------------------------------------
Release:    0.14.0.1
Date:       July 24th, 2012

 * Restore spd queue insert code.

----------------------------------------
Release:    0.14.0.0
Date:       July 20th, 2012

 * Quijote internal logging with websockets.
 * Test resources to use SAL and returning full documents.
 * userByMail resource.
 * Dashboard cleanup.
 * Code cleanup.

----------------------------------------
Release:    0.13.0.1
Date:       July 4th, 2012

 * Fixed wrong urls in top location resource (was still using locationTree).

----------------------------------------
Release:    0.13.0.0
Date:       July 4th, 2012

 * Implement SiteLocation counters.
 * Use SiteLocations for SiteLocation children and ancestors.
 * Adapt status page to the new imager document format.
 * Fix status page DB report when the user has many grants.
 * Fix SH integration when no ip is sent in the posted document.
 * Refactor comments into it's own module.
 * Tests refactoring.



Since we know that the trunk will become 0.15.0 version at some point, we
start logging those changes for that release. Once release is
tagged/branches/whatever, we add 0.16.0 to the ChangeLog, and update the
0.15.0 date.

Comments are usually one liners, not necesary one-to-one related with
tickets/bugs/projects. We only log the more relevant things (we don't log
typos fixing, or small changes).


My two cents

-- 
Gabriel E. Patiño
http://about.me/gepatino