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
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,9 +41,8 @@
41
41
Contributing to Apache Commons CLI
42
42
======================
43
43
44
-
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
45
-
the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
46
-
follow so that we can have a chance of keeping on top of things.
44
+
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.
45
+
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.
47
46
48
47
Getting Started
49
48
---------------
@@ -62,7 +61,7 @@ Making Changes
62
61
63
62
+ Create a _topic branch_ for your isolated work.
64
63
* 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. `CLI-123-InputStream`.
64
+
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CLI-123-InputStream`.
66
65
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
67
66
+ Make commits of logical units.
68
67
* 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
72
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.
73
72
+ Check for unnecessary whitespace with `git diff` -- check before committing.
74
73
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
75
-
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
74
+
+ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken.
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-cli/download_cli.cgi).
64
64
65
-
Alternatively, you can pull it from the central Maven repositories:
65
+
Alternatively, you can pull it from the central Maven repositories:
66
66
67
67
```xml
68
68
<dependency>
69
69
<groupId>commons-cli</groupId>
70
70
<artifactId>commons-cli</artifactId>
71
-
<version>1.8.0</version>
71
+
<version>1.9.0</version>
72
72
</dependency>
73
73
```
74
74
75
75
Building
76
76
--------
77
77
78
-
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
78
+
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
79
79
The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
80
80
81
81
From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
@@ -88,7 +88,9 @@ There are some guidelines which will make applying PRs easier for us:
88
88
+ No tabs! Please use spaces for indentation.
89
89
+ Respect the existing code style for each file.
90
90
+ 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.
91
-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
91
+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
92
+
+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
93
+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`
92
94
93
95
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
94
96
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
0 commit comments