I find "Fix TUSCANY-xxx"
Less satisfactory than TUSCANY-xxx change abc because ... or change abc because ... For two reasons. 1/ I often look at the log of changes for a given file or a group if files. This shows a list of changes and having to de-reference to the JIRA is a pain when you are trying to get an overview of the ebb and flow of changes in a particular area. This is particularly the case when you are reading down a long list trying to find the particular change that is contributing to whatever problem you are currently working on. I think of it like reading the "CHANGES" file we create for a release as a whole. I find having just JIRA numbers there is also less that satisfactory. 2/ A JIRA often has many changes associated with it and tying down the reason for one particular change, even within the context of a single JIRA, is not always easy We may get to the point where it's a question of taste. It doesn't seem to me to be a great burden to put a sentence of explanation in at the point at which a change is committed, the point at which the change is fresh in the committers mind, to help those of us who find it useful regardless of whether the committer is going to use it in the future I am not proposing that for 2.x we have a JIRA for ever change. It is attractive for 1.x though where the changes are becoming more about maintenance and less about new development. Simon
