Skip to content

Commit 89cbc7b

Browse files
committed
Prepare for the next release candidate
1 parent 447682e commit 89cbc7b

8 files changed

Lines changed: 433 additions & 462 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ Getting Started
4949
---------------
5050

5151
+ 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).
52+
+ Make sure you have a [GitHub account](https://github.com/signup/free). This is not essential, but makes providing patches much easier.
5353
+ If you're planning to implement a new feature it makes sense to discuss your 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.
5454
+ 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.
5757
+ 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+
[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. If you don't have a GitHub account, you can still clone the Commons repository.
5959

6060
Making Changes
6161
--------------
@@ -109,7 +109,6 @@ Additional Resources
109109
+ [General GitHub documentation](https://help.github.com/)
110110
+ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/)
111111
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
112-
+ `#apache-commons` IRC channel on `irc.freenode.net`
113112

114113
[cla]:https://www.apache.org/licenses/#clas
115114
[jira]:https://issues.apache.org/jira/browse/CSV

README.md

Lines changed: 19 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Apache Commons CSV
4646
[![Java CI](https://github.com/apache/commons-csv/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-csv/actions/workflows/maven.yml)
4747
[![Coverage Status](https://codecov.io/gh/apache/commons-csv/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-csv)
4848
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-csv/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-csv/?gav=true)
49-
[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-csv/1.10.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-csv/1.10.0)
49+
[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-csv/1.11.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-csv/1.11.0)
5050
[![CodeQL](https://github.com/apache/commons-csv/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-csv/actions/workflows/codeql-analysis.yml)
5151
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-csv/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-csv)
5252

@@ -59,27 +59,35 @@ More information can be found on the [Apache Commons CSV homepage](https://commo
5959
The [Javadoc](https://commons.apache.org/proper/commons-csv/apidocs) can be browsed.
6060
Questions related to the usage of Apache Commons CSV should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html).
6161

62-
Where can I get the latest release?
63-
-----------------------------------
62+
Getting the latest release
63+
--------------------------
6464
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-csv/download_csv.cgi).
6565

66-
Alternatively, you can pull it from the central Maven repositories:
66+
Alternatively, you can pull it from the central Maven repositories:
6767

6868
```xml
6969
<dependency>
7070
<groupId>org.apache.commons</groupId>
7171
<artifactId>commons-csv</artifactId>
72-
<version>1.10.0</version>
72+
<version>1.11.0</version>
7373
</dependency>
7474
```
7575

76+
Building
77+
--------
78+
79+
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
80+
The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
81+
82+
From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
83+
7684
Contributing
7785
------------
7886

7987
We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
8088
There are some guidelines which will make applying PRs easier for us:
8189
+ No tabs! Please use spaces for indentation.
82-
+ Respect the code style.
90+
+ Respect the existing code style for each file.
8391
+ 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.
8492
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
8593

@@ -88,13 +96,13 @@ You can learn more about contributing via GitHub in our [contribution guidelines
8896

8997
License
9098
-------
91-
This code is under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
99+
This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
92100

93101
See the `NOTICE.txt` file for required notices and attributions.
94102

95-
Donations
96-
---------
97-
You like Apache Commons CSV? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
103+
Donating
104+
--------
105+
You like Apache Commons CSV? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.
98106

99107
Additional Resources
100108
--------------------
@@ -103,59 +111,8 @@ Additional Resources
103111
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CSV)
104112
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
105113
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
106-
+ `#apache-commons` IRC channel on `irc.freenode.org`
107114

108115
Apache Commons Components
109116
-------------------------
110117

111-
| Component | GitHub Repository | Apache Homepage |
112-
| --------- | ----------------- | ----------------|
113-
| Apache Commons BCEL | [commons-bcel](https://github.com/apache/commons-bcel) | [commons-bcel](https://commons.apache.org/proper/commons-bcel) |
114-
| Apache Commons Beanutils | [commons-beanutils](https://github.com/apache/commons-beanutils) | [commons-beanutils](https://commons.apache.org/proper/commons-beanutils) |
115-
| Apache Commons BSF | [commons-bsf](https://github.com/apache/commons-bsf) | [commons-bsf](https://commons.apache.org/proper/commons-bsf) |
116-
| Apache Commons Build-plugin | [commons-build-plugin](https://github.com/apache/commons-build-plugin) | [commons-build-plugin](https://commons.apache.org/proper/commons-build-plugin) |
117-
| Apache Commons Chain | [commons-chain](https://github.com/apache/commons-chain) | [commons-chain](https://commons.apache.org/proper/commons-chain) |
118-
| Apache Commons CLI | [commons-cli](https://github.com/apache/commons-cli) | [commons-cli](https://commons.apache.org/proper/commons-cli) |
119-
| Apache Commons Codec | [commons-codec](https://github.com/apache/commons-codec) | [commons-codec](https://commons.apache.org/proper/commons-codec) |
120-
| Apache Commons Collections | [commons-collections](https://github.com/apache/commons-collections) | [commons-collections](https://commons.apache.org/proper/commons-collections) |
121-
| Apache Commons Compress | [commons-compress](https://github.com/apache/commons-compress) | [commons-compress](https://commons.apache.org/proper/commons-compress) |
122-
| Apache Commons Configuration | [commons-configuration](https://github.com/apache/commons-configuration) | [commons-configuration](https://commons.apache.org/proper/commons-configuration) |
123-
| Apache Commons Crypto | [commons-crypto](https://github.com/apache/commons-crypto) | [commons-crypto](https://commons.apache.org/proper/commons-crypto) |
124-
| Apache Commons CSV | [commons-csv](https://github.com/apache/commons-csv) | [commons-csv](https://commons.apache.org/proper/commons-csv) |
125-
| Apache Commons Daemon | [commons-daemon](https://github.com/apache/commons-daemon) | [commons-daemon](https://commons.apache.org/proper/commons-daemon) |
126-
| Apache Commons DBCP | [commons-dbcp](https://github.com/apache/commons-dbcp) | [commons-dbcp](https://commons.apache.org/proper/commons-dbcp) |
127-
| Apache Commons Dbutils | [commons-dbutils](https://github.com/apache/commons-dbutils) | [commons-dbutils](https://commons.apache.org/proper/commons-dbutils) |
128-
| Apache Commons Digester | [commons-digester](https://github.com/apache/commons-digester) | [commons-digester](https://commons.apache.org/proper/commons-digester) |
129-
| Apache Commons Email | [commons-email](https://github.com/apache/commons-email) | [commons-email](https://commons.apache.org/proper/commons-email) |
130-
| Apache Commons Exec | [commons-exec](https://github.com/apache/commons-exec) | [commons-exec](https://commons.apache.org/proper/commons-exec) |
131-
| Apache Commons Fileupload | [commons-fileupload](https://github.com/apache/commons-fileupload) | [commons-fileupload](https://commons.apache.org/proper/commons-fileupload) |
132-
| Apache Commons Functor | [commons-functor](https://github.com/apache/commons-functor) | [commons-functor](https://commons.apache.org/proper/commons-functor) |
133-
| Apache Commons Geometry | [commons-geometry](https://github.com/apache/commons-geometry) | [commons-geometry](https://commons.apache.org/proper/commons-geometry) |
134-
| Apache Commons Graph | [commons-graph](https://github.com/apache/commons-graph) | [commons-graph](https://commons.apache.org/proper/commons-graph) |
135-
| Apache Commons Imaging | [commons-imaging](https://github.com/apache/commons-imaging) | [commons-imaging](https://commons.apache.org/proper/commons-imaging) |
136-
| Apache Commons IO | [commons-io](https://github.com/apache/commons-io) | [commons-io](https://commons.apache.org/proper/commons-io) |
137-
| Apache Commons JCI | [commons-jci](https://github.com/apache/commons-jci) | [commons-jci](https://commons.apache.org/proper/commons-jci) |
138-
| Apache Commons JCS | [commons-jcs](https://github.com/apache/commons-jcs) | [commons-jcs](https://commons.apache.org/proper/commons-jcs) |
139-
| Apache Commons Jelly | [commons-jelly](https://github.com/apache/commons-jelly) | [commons-jelly](https://commons.apache.org/proper/commons-jelly) |
140-
| Apache Commons Jexl | [commons-jexl](https://github.com/apache/commons-jexl) | [commons-jexl](https://commons.apache.org/proper/commons-jexl) |
141-
| Apache Commons Jxpath | [commons-jxpath](https://github.com/apache/commons-jxpath) | [commons-jxpath](https://commons.apache.org/proper/commons-jxpath) |
142-
| Apache Commons Lang | [commons-lang](https://github.com/apache/commons-lang) | [commons-lang](https://commons.apache.org/proper/commons-lang) |
143-
| Apache Commons Logging | [commons-logging](https://github.com/apache/commons-logging) | [commons-logging](https://commons.apache.org/proper/commons-logging) |
144-
| Apache Commons Math | [commons-math](https://github.com/apache/commons-math) | [commons-math](https://commons.apache.org/proper/commons-math) |
145-
| Apache Commons Net | [commons-net](https://github.com/apache/commons-net) | [commons-net](https://commons.apache.org/proper/commons-net) |
146-
| Apache Commons Numbers | [commons-numbers](https://github.com/apache/commons-numbers) | [commons-numbers](https://commons.apache.org/proper/commons-numbers) |
147-
| Apache Commons Parent | [commons-parent](https://github.com/apache/commons-parent) | [commons-parent](https://commons.apache.org/proper/commons-parent) |
148-
| Apache Commons Pool | [commons-pool](https://github.com/apache/commons-pool) | [commons-pool](https://commons.apache.org/proper/commons-pool) |
149-
| Apache Commons Proxy | [commons-proxy](https://github.com/apache/commons-proxy) | [commons-proxy](https://commons.apache.org/proper/commons-proxy) |
150-
| Apache Commons RDF | [commons-rdf](https://github.com/apache/commons-rdf) | [commons-rdf](https://commons.apache.org/proper/commons-rdf) |
151-
| Apache Commons Release-plugin | [commons-release-plugin](https://github.com/apache/commons-release-plugin) | [commons-release-plugin](https://commons.apache.org/proper/commons-release-plugin) |
152-
| Apache Commons Rng | [commons-rng](https://github.com/apache/commons-rng) | [commons-rng](https://commons.apache.org/proper/commons-rng) |
153-
| Apache Commons Scxml | [commons-scxml](https://github.com/apache/commons-scxml) | [commons-scxml](https://commons.apache.org/proper/commons-scxml) |
154-
| Apache Commons Signing | [commons-signing](https://github.com/apache/commons-signing) | [commons-signing](https://commons.apache.org/proper/commons-signing) |
155-
| Apache Commons Skin | [commons-skin](https://github.com/apache/commons-skin) | [commons-skin](https://commons.apache.org/proper/commons-skin) |
156-
| Apache Commons Statistics | [commons-statistics](https://github.com/apache/commons-statistics) | [commons-statistics](https://commons.apache.org/proper/commons-statistics) |
157-
| Apache Commons Testing | [commons-testing](https://github.com/apache/commons-testing) | [commons-testing](https://commons.apache.org/proper/commons-testing) |
158-
| Apache Commons Text | [commons-text](https://github.com/apache/commons-text) | [commons-text](https://commons.apache.org/proper/commons-text) |
159-
| Apache Commons Validator | [commons-validator](https://github.com/apache/commons-validator) | [commons-validator](https://commons.apache.org/proper/commons-validator) |
160-
| Apache Commons VFS | [commons-vfs](https://github.com/apache/commons-vfs) | [commons-vfs](https://commons.apache.org/proper/commons-vfs) |
161-
| Apache Commons Weaver | [commons-weaver](https://github.com/apache/commons-weaver) | [commons-weaver](https://commons.apache.org/proper/commons-weaver) |
118+
Please see the [list of components](https://commons.apache.org/components.html)

0 commit comments

Comments
 (0)