|
| 1 | +<!--- |
| 2 | + Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | + contributor license agreements. See the NOTICE file distributed with |
| 4 | + this work for additional information regarding copyright ownership. |
| 5 | + The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | + (the "License"); you may not use this file except in compliance with |
| 7 | + the License. You may obtain a copy of the License at |
| 8 | +
|
| 9 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +
|
| 11 | + Unless required by applicable law or agreed to in writing, software |
| 12 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + See the License for the specific language governing permissions and |
| 15 | + limitations under the License. |
| 16 | +--> |
| 17 | +<!--- |
| 18 | + +======================================================================+ |
| 19 | + |**** ****| |
| 20 | + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| |
| 21 | + |**** DO NOT EDIT DIRECTLY ****| |
| 22 | + |**** ****| |
| 23 | + +======================================================================+ |
| 24 | + | TEMPLATE FILE: contributing-md-template.md | |
| 25 | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | |
| 26 | + +======================================================================+ |
| 27 | + | | |
| 28 | + | 1) Re-generate using: mvn commons:contributing-md | |
| 29 | + | | |
| 30 | + | 2) Set the following properties in the component's pom: | |
| 31 | + | - commons.jira.id (required, alphabetic, upper case) | |
| 32 | + | | |
| 33 | + | 3) Example Properties | |
| 34 | + | | |
| 35 | + | <properties> | |
| 36 | + | <commons.jira.id>MATH</commons.jira.id> | |
| 37 | + | </properties> | |
| 38 | + | | |
| 39 | + +======================================================================+ |
| 40 | +---> |
| 41 | +Contributing to Apache Commons CSV |
| 42 | +====================== |
| 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. |
| 47 | + |
| 48 | +Getting Started |
| 49 | +--------------- |
| 50 | + |
| 51 | ++ Make sure you have a [JIRA account](https://issues.apache.org/jira/). |
| 52 | ++ Make sure you have a [GitHub account](https://github.com/signup/free). |
| 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 CSV's scope. |
| 54 | ++ Submit a ticket for your issue, assuming one does not already exist. |
| 55 | + + Clearly describe the issue including steps to reproduce when it is a bug. |
| 56 | + + Make sure you fill in the earliest version that you know has the issue. |
| 57 | ++ Fork the repository on GitHub. |
| 58 | + |
| 59 | +Making Changes |
| 60 | +-------------- |
| 61 | + |
| 62 | ++ Create a topic branch from where you want to base your work (this is usually the master/trunk branch). |
| 63 | ++ Make commits of logical units. |
| 64 | ++ Respect the original code style: |
| 65 | + + 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. |
| 70 | ++ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken. |
| 71 | + |
| 72 | +Making Trivial Changes |
| 73 | +---------------------- |
| 74 | + |
| 75 | +For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. |
| 76 | +In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number. |
| 77 | + |
| 78 | +Submitting Changes |
| 79 | +------------------ |
| 80 | + |
| 81 | ++ Sign the [Contributor License Agreement][cla] if you haven't already. |
| 82 | ++ 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. |
| 84 | ++ Update your JIRA ticket and include a link to the pull request in the ticket. |
| 85 | + |
| 86 | +Additional Resources |
| 87 | +-------------------- |
| 88 | + |
| 89 | ++ [Contributing patches](https://commons.apache.org/patches.html) |
| 90 | ++ [Apache Commons CSV JIRA project page](https://issues.apache.org/jira/browse/CSV) |
| 91 | ++ [Contributor License Agreement][cla] |
| 92 | ++ [General GitHub documentation](https://help.github.com/) |
| 93 | ++ [GitHub pull request documentation](https://help.github.com/send-pull-requests/) |
| 94 | ++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) |
| 95 | ++ #apachecommons IRC channel on freenode.org |
| 96 | + |
| 97 | +[cla]:https://www.apache.org/licenses/#clas |
0 commit comments