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 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.
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. `CSV-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. `CSV-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.
Copy file name to clipboardExpand all lines: RELEASE-NOTES.txt
+57Lines changed: 57 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,60 @@
1
+
Apache Commons CSV
2
+
Version 1.5
3
+
Release Notes
4
+
5
+
6
+
INTRODUCTION:
7
+
8
+
This document contains the release notes for the 1.5 version of Apache Commons CSV.
9
+
Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format.
10
+
11
+
CSV requires at least Java 7.
12
+
13
+
The Apache Commons CSV library provides a simple interfa
AD90
ce for reading and writing
14
+
CSV files of various types.
15
+
16
+
Feature and bug fix release
17
+
18
+
Changes in this version include:
19
+
20
+
NEW FEATURES
21
+
==============
22
+
23
+
o CSV-189: CSVParser: Add factory method accepting InputStream. Thanks to Peter Holzwarth, Gary Gregory.
24
+
o CSV-190: Add convenience API CSVFormat.print(File, Charset). Thanks to Gary Gregory.
25
+
o CSV-191: Add convenience API CSVFormat.print(Path, Charset). Thanks to Gary Gregory.
26
+
o CSV-192: Add convenience API CSVParser.parse(Path, Charset, CSVFormat). Thanks to Gary Gregory.
27
+
o CSV-205: Add convenience API CSVFormat#printer() to print to System.out. Thanks to Gary Gregory.
28
+
o CSV-207: Provide a CSV Format for printing PostgreSQL CSV and Text formats. Thanks to Gary Gregory.
29
+
o CSV-214: Adding a placeholder in the Lexer and CSV parser to store the end-of-line string. Thanks to Nitin Mahendru, Gary Gregory.
30
+
31
+
FIXED BUGS
32
+
============
33
+
34
+
o CSV-203: withNullString value is printed without quotes when QuoteMode.ALL is specified; add QuoteMode.ALL_NON_NULL. PR #17. Thanks to Richard Wheeldon, Kai Paroth.
35
+
o CSV-194: Fix outdated comments about FileReader in CSVParser #13. Thanks to Marc Prud'hommeaux.
36
+
o CSV-193: Fix incorrect method name 'withFirstRowAsHeader' in user guide. Thanks to Matthias Wiehl.
37
+
o CSV-171: Negative numeric values in the first column are always quoted in minimal mode. Thanks to Gary Gregory, Michael Graessle, Adrian Bridgett.
38
+
39
+
CHANGES
40
+
=========
41
+
42
+
o CSV-187: Update platform requirement from Java 6 to 7. Thanks to Gary Gregory.
43
+
o CSV-201: Do not use RuntimeException in CSVParser.iterator().new Iterator() {...}.getNextRecord(). Thanks to Benedikt Ritter, Gary Gregory.
44
+
45
+
46
+
Historical list of changes: http://commons.apache.org/proper/commons-csv/changes-report.html
47
+
48
+
For complete information on Apache Commons CSV, including instructions on how to submit bug reports,
49
+
patches, or suggestions for improvement, see the Apache Apache Commons CSV website:
<releaseversion="1.6"date="2017-MM-DD"description="Feature and bug fix release">
42
+
<actionissue="CSV-217"type="add"dev="ggregory"due-to="Korolyov Alexei">Add autoFlush option for CsvPrinter. PR #24.</action>
43
+
<actionissue="CSV-219"type="fix"dev="ggregory"due-to="Zhang Hongda">The behavior of quote char using is not similar as Excel does when the first string contains CJK char(s).</action>
44
+
<actionissue="CSV-172"type="fix"dev="ggregory"due-to="Andrew Pennebaker">Don't quote cells just because they have UTF-8 encoded characters.</action>
45
+
<actionissue="CSV-220"type="add"dev="ggregory"due-to="Gary Gregory">Add API org.apache.commons.csv.CSVFormat.withSystemRecordSeparator().</action>
46
+
</release>
47
+
<releaseversion="1.5"date="2017-09-03"description="Feature and bug fix release">
42
48
<actionissue="CSV-203"type="fix"dev="ggregory"due-to="Richard Wheeldon, Kai Paroth">withNullString value is printed without quotes when QuoteMode.ALL is specified; add QuoteMode.ALL_NON_NULL. PR #17.</action>
43
49
<actionissue="CSV-194"type="fix"dev="ggregory"due-to="Marc Prud'hommeaux">Fix outdated comments about FileReader in CSVParser #13</action>
44
50
<actionissue="CSV-193"type="fix"dev="ggregory"due-to="Matthias Wiehl">Fix incorrect method name 'withFirstRowAsHeader' in user guide.</action>
0 commit comments