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
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,11 +61,11 @@ Making Changes
61
61
62
62
+ Create a _topic branch_ for your isolated work.
63
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,`LANG-123-InputStream`.
64
+
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g.`LANG-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
-
* For example, `[LANG-123] Close input stream earlier`
68
+
* For example, `[LANG-123] Close input stream sooner`
69
69
+ Respect the original code style:
70
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.
@@ -76,7 +76,7 @@ Alternatively, you can pull it from the central Maven repositories:
76
76
<dependency>
77
77
<groupId>org.apache.commons</groupId>
78
78
<artifactId>commons-lang3</artifactId>
79
-
<version>3.17.0</version>
79
+
<version>3.18.0</version>
80
80
</dependency>
81
81
```
82
82
@@ -98,7 +98,7 @@ There are some guidelines which will make applying PRs easier for us:
98
98
+ 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.
99
99
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
100
100
+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
101
-
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`
101
+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
102
102
103
103
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
104
104
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
If you would like to report a bug, or raise an enhancement request with
66
68
Apache Commons Lang please do the following:
69
+
</p>
67
70
<ol>
68
71
<li><ahref="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310481&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
69
72
If you find your issue listed then please add a comment with your details.</li>
@@ -73,16 +76,15 @@ limitations under the License.
73
76
<li>Submit either a <ahref="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310481&issuetype=1&priority=4&assignee=-1">bug report</a>
74
77
or <ahref="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310481&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
75
78
</ol>
76
-
</p>
77
79
78
80
<p>
79
81
Please also remember these points:
82
+
</p>
80
83
<ul>
81
84
<li>the more information you provide, the better we can help you</li>
82
85
<li>test cases are vital, particularly for any proposed enhancements</li>
83
86
<li>the developers of Apache Commons Lang are all unpaid volunteers</li>
84
87
</ul>
85
-
</p>
86
88
87
89
<p>
88
90
For more information on creating patches see the
@@ -91,12 +93,12 @@ limitations under the License.
91
93
92
94
<p>
93
95
You may also find these links useful:
96
+
</p>
94
97
<ul>
95
98
<li><ahref="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310481&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Apache Commons Lang bugs</a></li>
96
99
<li><ahref="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310481&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Apache Commons Lang bugs</a></li>
97
100
<li><ahref="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310481&sorter/field=issuekey&sorter/order=DESC">All Apache Commons Lang bugs</a></li>
0 commit comments