You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+11-8
Original file line number
Diff line number
Diff line change
@@ -60,26 +60,29 @@ Making Changes
60
60
--------------
61
61
62
62
+ 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`.
65
65
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
66
66
+ Make commits of logical units.
67
67
* 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`
69
69
+ 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.
71
71
+ 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
+
75
78
76
79
Making Trivial Changes
77
80
----------------------
78
81
79
82
The JIRA tickets are used to generate the changelog for the next release.
80
83
81
84
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.
0 commit comments