From: Egon W. <eg...@us...> - 2005-05-08 21:02:01
|
Hi all, after a new build system, CDK now also uses a new system for the ChangeLog. The new system is XML based allowing better markup of the information contained in the items. Typical entries now looks like: <addition contributor="meklund"> Added AminoAcid templates </addition> <bugfix contributor="steinbeck" closes="934819 931608"> Fixed false handling of terminal branched groups in Fingerprinter </bugfix> <apiChange implements="1175952"> The cdk.layout.TemplateHandler now uses CML2 files </apiChange> The general structure of the document is /changelog/release/[addition | bugfix | apiChange]. The system comes with an XML Schema, so editing the changelog.xml in jEdit with the XML plugin installed will automatically help you keep the file syntactically correct. The above shows some new features: - closes attribute => for bugs this entry closes - implements attribute => for feature requests this entry closes - contributor attribute => statement who contributed this change The last change is mostly for opening the possibility to acknowledge patch submitters. Patches currently are applied by me or Christoph, so that CVS is a bad indicator who actually contributed what. Note, that contributors have to be explicitly given the in the XML Schema: a contributor ID has to be defined, and a bit of comment (should probably be <xsd:annotation>) is expected to be added for a full name *and* email address. As ID, SF accounts are preferred. Giving the attribute is optional, but highly encouraged. If properly used we could make some statistics, e.g. on the number of contributors for each release. Additionally, having the bug numbers and RFE numbers in attributes allows us to make links from the changelog items directly to the original bug reports on SF, allowing even more integration of the development process of CDK. Though I'm already quite happy with the available feature, comments and ideas are highly appreciated. Egon -- eg...@us... GPG: 1024D/D6336BA6 |