...
| 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 recommend way to build the hash() and equals() methods is to use the EqualsBuilder and HashCodeBuilder classes form the commons-lang(3) jar.
Template for commit messages
Short (50 chars or less) summary of changes.
More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. In some contexts, the first line is treated as the subject of an email and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); tools like rebase can get confused if you run the two together.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded by a single space, with blank lines in between.
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.
IDE Settings
Eclipse
...