...
| Table of Contents |
|---|
Following the lead of well established projects such as Apache and Eclipse, all code in CAS will comply with the Code Conventions for the Java and additionally with the CAS specific conventions listed below. Javadoc should exist on all publicly exported class members [Bloch, 2001] and follow the How to Write Doc Comments for the Javadoc Tool style guide.
...
The summary should contain both a Jira issue number where possible and a brief description, e.g.
| Code Block | ||||
|---|---|---|---|---|
| ||||
CAS-31415: Upgrade JDK source version to Java 9. Upgrading to JDK version 9 in order to solve a number of problems with the code. |
Placing _both_ the issue number and brief description would improve commit history in SCM. The old practice where the Jira number exclusively is on the first line makes it hard to follow commit history in a pull request and other situations.
...