Emerald Hand Wiki

Xelog - Log - Update

Modified: 2007/03/21 10:41 by Ornus - Categorized as: Usage, Xelog
Updating Xelog based change log is quite simple. In most instances you only need to add new change entry (fix, newFeature, enhancement or task).

You need to decide what component was changed, or if the change affected the whole project, and place the entry accordingly (in version or component). You can find more details in /CreateXelogFile.

On rare occasions you will need to start a new version section for a new version of the project you're working on. Again, you can find more details in Create log.

Edit

When to update

I think there are two approaches developers take to updating change log. You can either update it at the end, right before the release, or you can update it as you write code. People tend to wait until the last moment because it can be almost painful to write one, so they try to avoid doing it. I think a lot of pain comes from inadequate tools and with Xelog I try to make the whole experience easier. Even if it will still be painful, I want there to be as little pain as possible.

In general it's better and easier to update the change log as you are implementing changes to the project while your memory is still fresh.

Copyright © 2006-2008 Emerald Hand, Inc. All rights reserved.
Powered by ScrewTurn Wiki version 2.0.34. Some of the icons created by FamFamFam.