This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jelly.git
The following commit(s) were added to refs/heads/master by this push:
new 0b19694c Add contributing file from user feedback
0b19694c is described below
commit 0b19694cf3eb8e1c21626b88255d83cf087ea0ea
Author: Gary D. Gregory <[email protected]>
AuthorDate: Mon Jan 27 09:18:14 2025 -0500
Add contributing file from user feedback
---
CONTRIBUTING.md | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a00f936b..f1749469 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -62,15 +62,14 @@ Making Changes
+ Create a _topic branch_ for your isolated work.
* Usually you should base your branch on the `master` or `trunk` branch.
- * A good topic branch name can be the JIRA bug id plus a keyword, e.g.
`JELLY-123-InputStream`.
+ * A good topic branch name can be the JIRA bug id plus a keyword, for
example, `JELLY-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. `JELLY-123: Close input stream earlier`
+ * For example, `[JELLY-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.
@@ -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
