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
+29-11Lines changed: 29 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,47 +51,65 @@ Getting Started
51
51
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
52
52
+ Make sure you have a [GitHub account](https://github.com/signup/free).
53
53
+ If you're planning to implement a new feature it makes sense to discuss you're changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons IO's scope.
54
-
+ Submit a ticket for your issue, assuming one does not already exist.
54
+
+ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
55
55
+ Clearly describe the issue including steps to reproduce when it is a bug.
56
56
+ Make sure you fill in the earliest version that you know has the issue.
57
-
+ Fork the repository on GitHub.
57
+
+ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-),
58
+
[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository.
58
59
59
60
Making Changes
60
61
--------------
61
62
62
-
+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch).
63
+
+ Create a _topic branch_ for your isolated work.
64
+
* Usually you should base your branch on the `master` or `trunk` branch.
65
+
* A good topic branch name can be the JIRA bug id plus a keyword, e.g. `IO-123-InputStream`.
66
+
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
63
67
+ Make commits of logical units.
68
+
* Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
69
+
* e.g. `IO-123: Close input stream earlier`
64
70
+ Respect the original code style:
65
71
+ Only use spaces for indentation.
66
-
+ 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.
67
-
+ Check for unnecessary whitespace with git diff --check before committing.
68
-
+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
69
-
+ Make sure you have added the necessary tests for your changes.
72
+
+ 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
+
+ Check for unnecessary whitespace with `git diff` -- check before committing.
74
+
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
70
75
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
71
76
72
77
Making Trivial Changes
73
78
----------------------
74
79
80
+
The JIRA tickets are used to generate the changelog for the next release.
81
+
75
82
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
76
83
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
77
84
85
+
78
86
Submitting Changes
79
87
------------------
80
88
81
-
+ Sign the [Contributor License Agreement][cla] if you haven't already.
89
+
+ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already.
90
+
* Note that small patches & typical bug fixes do not require a CLA as
91
+
clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions)
92
+
covers them.
82
93
+ Push your changes to a topic branch in your fork of the repository.
83
-
+ Submit a pull request to the repository in the apache organization.
94
+
+ Submit a _Pull Request_ to the corresponding repository in the `apache` organization.
95
+
* Verify _Files Changed_ shows only your intended changes and does not
96
+
include additional files like `target/*.class`
84
97
+ Update your JIRA ticket and include a link to the pull request in the ticket.
85
98
99
+
If you prefer to not use GitHub, then you can instead use
100
+
`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue.
Commons IO uses <ahref="http://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
54
-
See the <ahref="http://issues.apache.org/jira/browse/IO">Commons IO JIRA project page</a>.
53
+
Apache Commons IO uses <ahref="https://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
54
+
See the <ahref="https://issues.apache.org/jira/browse/IO">Apache Commons IO JIRA project page</a>.
55
55
</p>
56
56
57
57
<p>
58
-
To use JIRA you may need to <ahref="http://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a>
58
+
To use JIRA you may need to <ahref="https://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a>
59
59
(if you have previously created/updated Commons issues using Bugzilla an account will have been automatically
60
-
created and you can use the <ahref="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a>
60
+
created and you can use the <ahref="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a>
61
61
page to get a new password).
62
62
</p>
63
63
64
64
<p>
65
65
If you would like to report a bug, or raise an enhancement request with
66
-
Commons IO please do the following:
66
+
Apache Commons IO please do the following:
67
67
<ol>
68
-
<li><ahref="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
68
+
<li><ahref="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
69
69
If you find your issue listed then please add a comment with your details.</li>
70
70
<li><ahref="mail-lists.html">Search the mailing list archive(s)</a>.
71
71
You may find your issue or idea has already been discussed.</li>
72
72
<li>Decide if your issue is a bug or an enhancement.</li>
73
-
<li>Submit either a <ahref="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&issuetype=1&priority=4&assignee=-1">bug report</a>
74
-
or <ahref="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
73
+
<li>Submit either a <ahref="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&issuetype=1&priority=4&assignee=-1">bug report</a>
74
+
or <ahref="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
75
75
</ol>
76
76
</p>
77
77
@@ -80,7 +80,7 @@ limitations under the License.
80
80
<ul>
81
81
<li>the more information you provide, the better we can help you</li>
82
82
<li>test cases are vital, particularly for any proposed enhancements</li>
83
-
<li>the developers of Commons IO are all unpaid volunteers</li>
83
+
<li>the developers of Apache Commons IO are all unpaid volunteers</li>
84
84
</ul>
85
85
</p>
86
86
@@ -92,9 +92,9 @@ limitations under the License.
92
92
<p>
93
93
You may also find these links useful:
94
94
<ul>
95
-
<li><ahref="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Commons IO bugs</a></li>
0 commit comments