[Dev] HISTORY.txt

Ted Leung twl at osafoundation.org
Tue Nov 9 17:03:56 PST 2004


We are going to have API's that developers will use.  When those API's 
change, we need to document that.  Changes that will break external 
parcels between milestones are the changes that I think we should be 
recording.  Recording changes to the details of implementations is 
unnecessary (that's what commit messages are supposed to be for).

Ted

On Nov 9, 2004, at 4:39 PM, Heikki Toivonen wrote:

> Ducky Sherwood wrote:
>> In some sense, we aren't keeping the developer information -- the 
>> HISTORY.txt is pretty high level.  Should I start including 
>> implementation details in HISTORY.txt?
>
> I am not a big fan of trying to maintain developer-level 
> history/changelog document. In a project the size of Chandler I think 
> it is simply impossible. I would rather rely on querying for the 
> changelogas via Bonsai (or some other similar tool). So, I in fact 
> would be in favor of getting rid of the developer level change history 
> altogether.
>
> Note that I do think the "what's new in this release" documents are 
> useful for end users, and to some extend developers as well. But I 
> think these should be hand created every release (not milestone).
>
> -- 
>   Heikki Toivonen
>
> _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
>
> Open Source Applications Foundation "Dev" mailing list
> http://lists.osafoundation.org/mailman/listinfo/dev
>



More information about the Dev mailing list