Skip to content

Commit 1c60088

Browse files
committed
Update contributing file from user feedback
1 parent 53acefd commit 1c60088

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,15 @@ Making Changes
6161
--------------
6262

6363
+ Create a _topic branch_ for your isolated work.
64-
* Usually you should base your branch on the `master` branch.
65-
* A good topic branch name can be the JIRA bug id plus a keyword, e.g. `WEAVER-123-InputStream`.
64+
* Usually you should base your branch from the `master` branch.
65+
* A good topic branch name can be the JIRA bug id plus a keyword, for example, `WEAVER-123-InputStream`.
6666
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
6767
+ Make commits of logical units.
6868
* Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
69-
* e.g. `WEAVER-123: Close input stream earlier`
69+
* For example, `[WEAVER-123] Close input stream earlier`
7070
+ Respect the original code style:
71-
+ Only use spaces for indentation.
71+
+ Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing.
7272
+ 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.
73-
+ Check for unnecessary whitespace with `git diff` -- check before committing.
7473
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
7574
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
7675

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

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

8584

8685
Submitting Changes

0 commit comments

Comments
 (0)