Skip to content

Commit 5f76abb

Browse files
committed
Update contributing file from user feedback
1 parent a38de95 commit 5f76abb

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

CONTRIBUTING.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -60,26 +60,29 @@ Making Changes
6060
--------------
6161

6262
+ Create a _topic branch_ for your isolated work.
63-
* Usually you should base your branch on the `master` branch.
64-
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CODEC-123-InputStream`.
63+
* Usually you should base your branch from the `master` branch.
64+
* A good topic branch name can be the JIRA bug ID plus a keyword, for example, `CODEC-123-InputStream`.
6565
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
6666
+ Make commits of logical units.
6767
* Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
68-
* e.g. `CODEC-123: Close input stream earlier`
68+
* For example, `[CODEC-123] Close input stream earlier`
6969
+ Respect the original code style:
70-
+ Only use spaces for indentation.
70+
+ Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing.
7171
+ 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.
72-
+ Check for unnecessary whitespace with `git diff` -- check before committing.
73-
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
74-
+ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken.
72+
+ Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible but is a best-practice.
73+
Unit tests are typically in the `src/test/java` directory.
74+
+ Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself.
75+
+ Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
76+
+ Each commit in the pull request should have a meaningful subject line and body. Note that commits might be squashed by a maintainer on merge.
77+
7578

7679
Making Trivial Changes
7780
----------------------
7881

7982
The JIRA tickets are used to generate the changelog for the next release.
8083

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

8487

8588
Submitting Changes

0 commit comments

Comments
 (0)