Nigel Daley wrote:
As you know, we've added a release note field in Jira from which we can
build a reasonable set of user facing release notes.
I always thought that the message in CHANGES.txt should be written for
end-users. Isn't that the case? If so, shouldn't we strive to improve
& better structure these instead or in addition?
I guess I'm still unclear on the difference between these. There are
now three places where we include summary descriptions of changes:
1. The commit message. This should usually be minimal, enough to jog
the memory, and always with a reference to the JIRA issue, but it does
not need to be sufficient for end users.
2. CHANGES.txt. We include one message per JIRA issue here, organized
into sections. These are meant to be user-readable. When combined with
updates to documentation (javadoc & forrest), they should be sufficient
for end users to understand how a change will affect them.
3. Jira release notes. See (2), above.
Is that right? Or is there some critical difference between (2) and
(3)? Or do you expect (2) to be more like (1)?
Doug
