Skip to content

Commit 62a29b8

Browse files
authored
docs: Replace JIRA with GitHub Issues (#3303)
And some general cleanup.
1 parent 4cfab6a commit 62a29b8

File tree

2 files changed

+20
-80
lines changed

2 files changed

+20
-80
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ LC_ALL=C ./mvnw clean install
6868

6969
## Features
7070

71-
Parquet is a very active project, and new features are being added quickly. Here are a few features:
72-
71+
Parquet is an active project, and new features are being added quickly. Here are a few features:
7372

7473
* Type-specific encoding
7574
* Hive integration (deprecated)
@@ -96,7 +95,9 @@ Parquet is a very active project, and new features are being added quickly. Here
9695

9796
## Java Vector API support
9897
`The feature is experimental and is currently not part of the parquet distribution`.
98+
9999
Parquet-Java has supported Java Vector API to speed up reading, to enable this feature:
100+
100101
* Java 17+, 64-bit
101102
* Requiring the CPU to support instruction sets:
102103
* avx512vbmi
@@ -116,26 +117,29 @@ Note that to use an Input or Output format, you need to implement a WriteSupport
116117
We've implemented this for 2 popular data formats to provide a clean migration path as well:
117118

118119
### Thrift
120+
119121
Thrift integration is provided by the [parquet-thrift](https://github.com/apache/parquet-java/tree/master/parquet-thrift) sub-project.
120122

121123
### Avro
124+
122125
Avro conversion is implemented via the [parquet-avro](https://github.com/apache/parquet-java/tree/master/parquet-avro) sub-project.
123126

124127
### Protobuf
128+
125129
Protobuf conversion is implemented via the [parquet-protobuf](https://github.com/apache/parquet-java/tree/master/parquet-protobuf) sub-project.
126130

127131
### Create your own objects
132+
128133
* The ParquetOutputFormat can be provided a WriteSupport to write your own objects to an event based RecordConsumer.
129134
* The ParquetInputFormat can be provided a ReadSupport to materialize your own objects by implementing a RecordMaterializer
130135

131136
See the APIs:
137+
132138
* [Record conversion API](https://github.com/apache/parquet-java/tree/master/parquet-column/src/main/java/org/apache/parquet/io/api)
133139
* [Hadoop API](https://github.com/apache/parquet-java/tree/master/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/api)
134140

135141
## Hive integration
136142

137-
Hive integration is provided via the [parquet-hive](https://github.com/apache/parquet-java/tree/master/parquet-hive) sub-project.
138-
139143
Hive integration is now deprecated within the Parquet project. It is now maintained by Apache Hive.
140144

141145
## Build
@@ -178,22 +182,22 @@ The current release is version `1.15.1`.
178182

179183
### How To Contribute
180184

181-
We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the [parquet-java](https://github.com/apache/parquet-java) Git repository. If you've previously forked Parquet from its old location, you will need to add a remote or update your origin remote to https://github.com/apache/parquet-java.git
185+
We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the [parquet-java](https://github.com/apache/parquet-java) Git repository. If you've previously forked Parquet from its old location, you will need to add a remote or update your origin remote to `https://github.com/apache/parquet-java.git`.
182186

183-
If you are looking for some ideas on what to contribute, check out jira issues for this project labeled ["pick-me-up"](https://issues.apache.org/jira/browse/PARQUET-5?jql=project%20%3D%20PARQUET%20and%20labels%20%3D%20pick-me-up%20and%20status%20%3D%20open).
184-
Comment on the issue and/or contact [dev@parquet.apache.org](http://mail-archives.apache.org/mod_mbox/parquet-dev/) with your questions and ideas.
187+
If you are looking for some ideas on what to contribute, check out [GitHub issues](https://github.com/apache/parquet-java/issues) for labeled [Good first issue](https://github.com/apache/parquet-java/issues?q=state%3Aopen%20label%3A%22Good%20first%20issue%22). Comment on the issue and/or contact [dev@parquet.apache.org](https://lists.apache.org/list.html?dev@parquet.apache.org) with your questions and ideas.
185188

186-
If you’d like to report a bug but don’t have time to fix it, you can still post it to our [issue tracker](https://issues.apache.org/jira/browse/PARQUET), or email the mailing list [dev@parquet.apache.org](http://mail-archives.apache.org/mod_mbox/parquet-dev/)
189+
If you’d like to report a bug but don’t have time to fix it, you can still raise an [issue on GitHub](https://github.com/apache/parquet-java/issues/new/choose), or email the mailing list [dev@parquet.apache.org](https://lists.apache.org/list.html?dev@parquet.apache.org).
187190

188191
To contribute a patch:
189192

190193
1. Break your work into small, single-purpose patches if possible. It’s much harder to merge in a large change with a lot of disjoint features.
191-
2. Create a JIRA for your patch on the [Parquet Project JIRA](https://issues.apache.org/jira/browse/PARQUET).
192-
3. Submit the patch as a GitHub pull request against the master branch. For a tutorial, see the GitHub guides on forking a repo and sending a pull request. Prefix your pull request name with the JIRA name (ex: https://github.com/apache/parquet-java/pull/240).
194+
2. Create an issue for your patch on the [GitHub issues](https://github.com/apache/parquet-java/issues).
195+
3. Submit the patch as a GitHub pull request against the master branch. For a tutorial, see the GitHub guides on forking a repo and sending a pull request. Prefix your pull request name with the issue (ex: https://github.com/apache/parquet-java/pull/3260).
193196
4. Make sure that your code passes the unit tests. You can run the tests with `./mvnw test` in the root directory.
194197
5. Add new unit tests for your code.
195198

196199
We tend to do fairly close readings of pull requests, and you may get a lot of comments. Some common issues that are not code structure related, but still important:
200+
197201
* Use 2 spaces for whitespace. Not tabs, not 4 spaces. The number of the spacing shall be 2.
198202
* Give your operators some room. Not `a+b` but `a + b` and not `foo(int a,int b)` but `foo(int a, int b)`.
199203
* Generally speaking, stick to the [Sun Java Code Conventions](http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html)
@@ -204,18 +208,20 @@ Thank you for getting involved!
204208
## Authors and contributors
205209

206210
* [Contributors](https://github.com/apache/parquet-java/graphs/contributors)
207-
* [Committers](dev/COMMITTERS.md)
211+
* [Committers](https://projects.apache.org/committee.html?parquet)
208212

209213
## Code of Conduct
210214

211215
We hold ourselves and the Parquet developer community to two codes of conduct:
216+
212217
1. [The Apache Software Foundation Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
213218
2. [The Twitter OSS Code of Conduct](https://github.com/twitter/code-of-conduct/blob/master/code-of-conduct.md)
214219

215220
## Discussions
216-
* Mailing list: [dev@parquet.apache.org](http://mail-archives.apache.org/mod_mbox/parquet-dev/)
217-
* Bug tracker: [jira](https://issues.apache.org/jira/browse/PARQUET)
218-
* Discussions also take place in github pull requests
221+
222+
* Mailing list: [dev@parquet.apache.org](https://lists.apache.org/list.html?dev@parquet.apache.org)
223+
* GitHub issues: [Issues](https://github.com/apache/parquet-java/issues)
224+
* Discussions also take place in GitHub pull requests
219225

220226
## License
221227

dev/COMMITTERS.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)