Skip to content

Commit

Permalink
Update contributing file from user feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Jan 27, 2025
1 parent cf212fa commit ade081c
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,15 @@ Making Changes
--------------

+ Create a _topic branch_ for your isolated work.
* Usually you should base your branch on the `master` branch.
* A good topic branch name can be the JIRA bug id plus a keyword, e.g. `IMAGING-123-InputStream`.
* Usually you should base your branch from the `master` branch.
* A good topic branch name can be the JIRA bug id plus a keyword, for example, `IMAGING-123-InputStream`.
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
+ Make commits of logical units.
* Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
* e.g. `IMAGING-123: Close input stream earlier`
* For example, `[IMAGING-123] Close input stream earlier`
+ Respect the original code style:
+ Only use spaces for indentation.
+ Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing.
+ Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first.
+ Check for unnecessary whitespace with `git diff` -- check before committing.
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.

Expand All @@ -80,7 +79,7 @@ Making Trivial Changes
The JIRA tickets are used to generate the changelog for the next release.

For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
In this case, it is appropriate to start the first line of a commit with '[doc]' or '[javadoc]' instead of a ticket number.


Submitting Changes
Expand Down

0 comments on commit ade081c

Please sign in to comment.