Skip to content
This repository was archived by the owner on Jun 3, 2026. It is now read-only.

Commit fd533e1

Browse files
britterbritter
committed
Add autogenerated readme.md and contributing.md
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1651287 13f79535-47bb-0310-9956-ffa450edef68
1 parent b3344a7 commit fd533e1

2 files changed

Lines changed: 158 additions & 12 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
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

‎README.md‎

Lines changed: 61 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,86 @@
1414
See the License for the specific language governing permissions and
1515
limitations under the License.
1616
-->
17+
<!---
18+
+======================================================================+
19+
|**** ****|
20+
|**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
21+
|**** DO NOT EDIT DIRECTLY ****|
22+
|**** ****|
23+
+======================================================================+
24+
| TEMPLATE FILE: readme-md-template.md |
25+
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
26+
+======================================================================+
27+
| |
28+
| 1) Re-generate using: mvn commons:readme-md |
29+
| |
30+
| 2) Set the following properties in the component's pom: |
31+
| - commons.componentid (required, alphabetic, lower case) |
32+
| - commons.release.version (required) |
33+
| |
34+
| 3) Example Properties |
35+
| |
36+
| <properties> |
37+
| <commons.componentid>math</commons.componentid> |
38+
| <commons.release.version>1.2</commons.release.version> |
39+
| </properties> |
40+
| |
41+
+======================================================================+
42+
--->
1743
Apache Commons CSV
1844
===================
1945

20-
The Apache Commons CSV library provides a simple interface for reading and writing CSV files of various types.
46+
The Apache Commons CSV library provides a simple interface for reading and writing
47+
CSV files of various types.
2148

22-
More information can be found on the [homepage][home].
49+
Documentation
50+
-------------
2351

24-
The [commons developer mailing list][ml] is the main channel of communication for contributors.
52+
More information can be found on the [homepage](https://commons.apache.org/proper/commons-csv).
53+
The [JavaDoc](https://commons.apache.org/proper/commons-csv/archives/1.1/apidocs/index.html) can be browsed.
54+
Questions related to the usage of Apache Commons CSV should be posted to the [user mailing list][ml].
2555

2656
Where can I get the latest release?
2757
-----------------------------------
28-
You can download source and binaries from our [download page][download].
58+
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-csv/download_csv.cgi).
2959

3060
Alternatively you can pull it from the central Maven repositories:
3161

3262
```xml
63+
<dependency>
3364
<groupId>org.apache.commons</groupId>
3465
<artifactId>commons-csv</artifactId>
35-
<version>1.0</version>
66+
<version>1.1</version>
67+
</dependency>
3668
```
3769

70+
Contributing
71+
------------
72+
73+
We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors.
74+
There are some guidelines which will make applying PRs easier for us:
75+
+ No tabs! Please use spaces for indentation.
76+
+ Respect the code style.
77+
+ 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.
78+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
79+
80+
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
81+
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
82+
3883
License
3984
-------
40-
Code is under the [Apache Licence v2][license].
85+
Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
4186

4287
Donations
4388
---------
44-
You like Apache Commons CSV? Then [donate back to the ASF][donate] to support the development.
89+
You like Apache Commons CSV? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
90+
91+
Additional Resources
92+
--------------------
93+
94+
+ [Apache Commons Homepage](https://commons.apache.org/)
95+
+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
96+
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
97+
+ #apachecommons IRC channel on freenode.org
4598

46-
[home]:http://commons.apache.org/csv
47-
[ml]:http://commons.apache.org/csv/mail-lists.html
48-
[download]:http://commons.apache.org/csv/download_csv.cgi
49-
[license]:http://www.apache.org/licenses/LICENSE-2.0.txt
50-
[donate]:http://www.apache.org/foundation/contributing.html
99+
[ml]:https://commons.apache.org/mail-lists.html

0 commit comments

Comments
 (0)