Skip to content

Commit 067b046

Browse files
committed
Update CONTRIBUTING.md for 1.5 release
1 parent 9479bfa commit 067b046

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,47 +51,65 @@ Getting Started
5151
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
5252
+ Make sure you have a [GitHub account](https://github.com/signup/free).
5353
+ 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 CSV'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.
5555
+ Clearly describe the issue including steps to reproduce when it is a bug.
5656
+ 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.
5859

5960
Making Changes
6061
--------------
6162

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. `CSV-123-InputStream`.
66+
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
6367
+ 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. `CSV-123: Close input stream earlier`
6470
+ Respect the original code style:
6571
+ 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`.
7075
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
7176

7277
Making Trivial Changes
7378
----------------------
7479

80+
The JIRA tickets are used to generate the changelog for the next release.
81+
7582
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
7683
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
7784

85+
7886
Submitting Changes
7987
------------------
8088

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.
8293
+ 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`
8497
+ Update your JIRA ticket and include a link to the pull request in the ticket.
8598

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.
101+
102+
86103
Additional Resources
87104
--------------------
88105

89106
+ [Contributing patches](https://commons.apache.org/patches.html)
90-
+ [Apache Commons CSV JIRA project page](https://issues.apache.org/jira/browse/CSV)
107+
+ [Apache Commons CSV JIRA project page][jira]
91108
+ [Contributor License Agreement][cla]
92109
+ [General GitHub documentation](https://help.github.com/)
93110
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
94111
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
95-
+ #apachecommons IRC channel on freenode.org
112+
+ `#apache-commons` IRC channel on `irc.freenode.net`
96113

97114
[cla]:https://www.apache.org/licenses/#clas
115+
[jira]:https://issues.apache.org/jira/browse/CSV

0 commit comments

Comments
 (0)