When providing patches for the Castor project, it is appreciated if time is taken to update the documenting files about the changes made. For easy reference, here is a list of steps that can be followed when creating a patch:
- Make the necessary changes (to source code or documentation) for the patch
- Update src/doc/release-notes.xml
- Add brief desription and reference to Jira issue in the <bugs> section
- For reasonably sized patches, add description to the <summary> section
- Update src/etc/CHANGELOG
- Include who provided the patch
- Include who requested the patch
- Include reference to Jira issue connected with the patch
- For documentation updates, edit src/doc/changes.xml
- Finally, create a unified patch of the src directory
- Attach patch to a Jira issue for review