CONTRIBUTING.md

Contributing guide

Want to contribute? Great! We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, examples... But first, read this page (including the small print at the end).

• Legal
• Reporting an issue
• Before you contribute
  • Code reviews
  • Coding Guidelines
  • Continuous Integration
  • Tests and documentation are not optional
• The small print

Legal

All original contributions to Apicurio projects are licensed under the ASL - Apache License, version 2.0 or later, or, if another license is specified as governing the file or directory being modified, such other license.

All contributions are subject to the Developer Certificate of Origin (DCO). The DCO text is also included verbatim in the dco.txt file in the root directory of the repository.

Reporting an issue

This project uses GitHub issues to manage the issues. Open an issue directly in GitHub.

If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing and what you would expect to see. Don't forget to indicate your Apicurio Registry, Java, and Maven versions.

Before you contribute

To contribute, use GitHub Pull Requests, from your own fork.

Also, make sure you have set up your Git authorship correctly:

git config --global user.name "Your Full Name"
git config --global user.email your.email@example.com

If you use different computers to contribute, please make sure the name is the same on all your computers.

We may use this information to acknowledge your contributions!

Code reviews

All submissions, including submissions by project members, need to be reviewed by at least one Apicurio committer before being merged.

GitHub Pull Request Review Process is followed for every pull request.

Coding Guidelines

• We primarily use the Git history to track authorship. GitHub also has this nice page with your contributions.
• Please take care to write code that fits with existing code styles. For your convenience we have Formatters and/or Code Templates for both Eclipse and IntelliJ.
• Commits should be atomic and semantic. Please properly squash your pull requests before submitting them. Fixup commits can be used temporarily during the review process but things should be squashed at the end to have meaningful commits.
• We typically squash and merge pull requests when they are approved. This tends to keep the commit history a little bit more tidy without placing undue burden on the developers.

Continuous Integration

Because we are all humans, and to ensure Apicurio Registry is stable for everyone, all changes must pass continuous integration before being merged. Apicurio CI is based on GitHub Actions, which means that pull requests will receive automatic feedback. Please watch out for the results of these workflows to see if your PR passes all tests.

Tests and documentation are not optional

Don't forget to include tests in your pull requests. Also don't forget the documentation (reference documentation, javadoc...).

Be sure to test your pull request using all storage variants:

1. SQL storage (using the -Psql profile)
2. KafkaSQL storage (using the -Pkafkasql profile)

The small print

This project is an open source project, please act responsibly, be nice, polite and enjoy!