##Verifying a release It is essential that you verify the integrity of the downloaded files using the PGP signatures or SHA512 checksums. Please read How to verify downloaded files for more information on why you should verify our releases.

The PGP signatures can be verified using PGP or GPG. First download the KEYS file as well as the .asc signature files for the relevant release packages. Make sure you get these files from the main distribution directory, rather than from a mirror. Then verify the signatures using:

% gpg --import KEYS
% gpg --verify downloaded_file.asc downloaded_file

% pgpk -a KEYS
% pgpv downloaded_file.asc

% pgp -ka KEYS
% pgp downloaded_file.asc

Alternatively, you can verify the hash on the file.

Hashes can be calculated using GPG:

% gpg --print-md SHA256 downloaded_file

The output should be compared with the contents of the SHA256 file. Similarly for other hashes (SHA512, SHA1, MD5 etc) which may be provided.

Windows 7 and later systems should all now have certUtil:

% certUtil -hashfile pathToFileToCheck

HashAlgorithm choices: MD2 MD4 MD5 SHA1 SHA256 SHA384 SHA512

Unix-like systems (and macOS) will have a utility called md5, md5sum or shasum.

2 - Credits

Apache Avro credits

Committers

Apache Avro’s active committers are:

username	name	organization	roles	timezone
blue	Ryan Blue	Netflix	spec, java, ruby	-8
brucem	Bruce Mitchener	Army of Bruce	c	+7
busbey	Sean Busbey	Cloudera	java, ruby	-6
cutting	Doug Cutting	Cloudera	spec, java	-8
dcreager	Douglas Creager	RedJack, LLC	c	-5
hammer	Jeff Hammerbacher	Cloudera	python	-8
iemejia	Ismaël Mejía	Talend	java, docker	+1
kojiromike	Michael A. Smith	Independent	python, docker	-5
massie	Matt Massie	UC Berkeley	c	-8
martinkl	Martin Kleppmann	University of Cambridge	c, ruby	0
nielsbasjes	Niels Basjes	Bol.com	java, docker	+1
philz	Philip Zeyliger	Cloudera	java	-8
rskraba	Ryan Skraba	Talend	java, docker	+1
sbanacho	Scott Banachowski	Microsoft	c++	-8
scottcarey	Scott Carey	RichRelevance	java	-8
sekikn	Kengo Seki	NTT Data	perl, interoperability	+9
sharadag	Sharad Agarwal	InMobi	python	+5.5
thiru	Thiruvalluvan M. G.	VertiCloud	java	+5.5
tomwhite	Tom White	Cloudera	java	0

Contributors

A list of Avro contributors and their contributions is available from Jira

Emeriti

Contributors who are no longer active on Avro are:

None

3 - How to contribute

Getting the source code

First of all, you need the Avro source code.

The easiest way is to clone or fork the GitHub mirror:

git clone https://github.com/apache/avro.git -o github

Making Changes

Before you start, file an issue in JIRA or discuss your ideas on the Avro developer mailing list. Describe your proposed changes and check that they fit in with what others are doing and have planned for the project. Be patient, it may take folks a while to understand your requirements.

Modify the source code and add some (very) nice features using your favorite IDE.

But take care about the following points

All Languages

Contributions should pass existing unit tests.
Contributions should document public facing APIs.
Contributions should add new tests to demonstrate bug fixes or test new features.

Java

All public classes and methods should have informative Javadoc comments.
Do not use @author tags.
Java code should be formatted according to Oracle’s conventions, with one exception:
- Indent two spaces per level, not four.
JUnit is our test framework:
You must implement a class whose class name starts with Test.
Define methods within your class and tag them with the @Test annotation. Call JUnit’s many assert methods to verify conditions; these methods will be executed when you run mvn test.
By default, do not let tests write any temporary files to /tmp. Instead, the tests should write to the location specified by the test.dir system property.
Place your class in the src/test/java/ tree.
You can run all the unit tests with the command mvn test, or you can run a specific unit test with the command mvn -Dtest=<class name, fully qualified or short name> test (for example mvn -Dtest=TestFoo test)

Code Style (Autoformatting)

For Java code we use Spotless to format the code to comply with Avro’s code style conventions (see above). Automatic formatting relies on Avro’s Eclipse JDT formatter definition. You can use the same definition to auto format from Eclipse or from IntelliJ configuring the Eclipse formatter plugin.

If you use maven code styles issues are checked at the compile phase. If your code breaks because of bad formatting, you can format it automatically by running the command:

mvn spotless:apply

Unit Tests

Please make sure that all unit tests succeed before constructing your patch and that no new compiler warnings are introduced by your patch. Each language has its own directory and test process.

Java

cd avro-trunk/lang/java
mvn clean test

Python

cd avro-trunk/lang/py
./setup.py build test

Rust

cd avro-trunk/lang/rust
./build.sh clean test

cd avro-trunk/lang/csharp
./build.sh clean test

cd avro-trunk/lang/c
./build.sh clean
./build.sh test

C++

cd avro-trunk/lang/c++
./build.sh clean test

Ruby

cd avro-trunk/lang/ruby
gem install echoe
rake clean test

PHP

cd avro-trunk/lang/php
./build.sh clean
./build.sh test

Contributing your code

Contribution can be made directly via github with a Pull Request, or via a patch.

Via Github

Method is to create a pull request.

On your fork, create a branch named with JIRA (avro-1234_fixNpe for example) On source, go to it

git pull
git switch avro-1234_fixNpe

code your changes (following preceding recommendations)

check and add updated sources

git status

# Add any new or changed files with:
git add src/.../MyNewClass.java
git add src/.../TestMyNewClass.java

Finally, create a commit with your changes and a good log message, and push it:

git commit -m "AVRO-1234: Fix NPE by adding check to ..."
git push

On your github fork site, a button will propose you to build the Pull Request. Click on it, fill Conversation form, and create it. Link this PR to the corresponding JIRA ticket (on JIRA ticket, add PR to “Issue Links” chapter, and add label ‘pull-request-available’ to it .

Jira Guidelines

Please comment on issues in Jira, making your concerns known. Please also vote for issues that are a high priority for you.

Please refrain from editing descriptions and comments if possible, as edits spam the mailing list and clutter Jira’s “All” display, which is otherwise very useful. Instead, preview descriptions and comments using the preview button (on the right) before posting them. Keep descriptions brief and save more elaborate proposals for comments, since descriptions are included in Jira’s automatically sent messages. If you change your mind, note this in a new comment, rather than editing an older comment. The issue should preserve this history of the discussion.

Stay involved

Contributors should join the Avro mailing lists. In particular, the commit list (to see changes as they are made), the dev list (to join discussions of changes) and the user list (to help others).

4 - License

Apache Avro project is licensed under Apache Software License 2.0

5 - Privacy policy

Apache Avro project shares the same privacy policy as the Apache Software Foundation

6 - Security

Apache Avro project shares the same security policy as the Apache Software Foundation

7 - Events

Apache Avro members often participate in events organized by the Apache Software Foundation

8 - Donate

If you would like to donate please see the Apache Software Foundation donation program

9 - Thanks

Apache Avro project could not exist without the continued generous support from the community! We would like to take this opportunity to thank the ASF Sponsors.

Project

1 - Download

Download

Release Notes