Prepare for the next release candidate
This commit is contained in:
@@ -41,9 +41,8 @@
|
||||
Contributing to Apache Commons Logging
|
||||
======================
|
||||
|
||||
You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to
|
||||
the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
|
||||
follow so that we can have a chance of keeping on top of things.
|
||||
Have you found a bug or have an idea for a cool new feature? Contributing code is a great way to give something back to the open-source community.
|
||||
Before you dig right into the code, we need contributors to follow a few guidelines to have a chance of keeping on top of things.
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
@@ -62,7 +61,7 @@ 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. `LOGGING-123-InputStream`.
|
||||
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `LOGGING-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.
|
||||
@@ -72,7 +71,7 @@ Making Changes
|
||||
+ 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.
|
||||
+ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken.
|
||||
|
||||
Making Trivial Changes
|
||||
----------------------
|
||||
|
||||
Reference in New Issue
Block a user