Best Practices for Apache cTAKES

For committers

Loading resources

Use FileLocator.getAsStream rather than accessing resources as a File:

• for consistency within cTAKES
• so that files within a jar can be accessed

Commits

If the change isn't related to an existing cTAKES JIRA item, create one so the release notes will automatically be updated.

Commit comments

Mention the JIRA item, CTAKES-### in the commit message, so the JIRA item will be updated automatically with a copy of the commit comment and the revision number.

Just as with code comments, why is more important than what.