Everyone is encouraged to contribute to the Nessie project. We welcome of course code changes, but we are also grateful for bug reports, feature suggestions, helping with testing and documentation, or simply spreading the word about Nessie.
There are several ways to get in touch with other contributors:
- Slack: get an invite to the channel by emailing [email protected]
- Google Groups: You can join the discussion at https://groups.google.com/g/projectnessie
More information are available at https://projectnessie.org/develop/
You must agree to abide by the Project Nessie Code of Conduct.
Issues can be filed on GitHub. Please use the template and add as much detail as possible. Including the version of the client and server, how the server is being run (eg docker image) etc. The more the community knows the more it can help :-)
If you have a feature request or questions about the direction of the project please join the slack channel and ask there. It helps build a richer discussion and more people can be involved than when posting as an issue.
We are excited to accept new contributors and larger changes. Please join the mailing list and post a proposal before submitting a large change. This helps avoid double work and allows the community to arrive at a consensue on the new feature or improvement.
The development process doesn't contain many surprises. As most projects on github anyone can contribute by forking the repo and posting a pull request. See GitHub's documentation for more information. Small changes don't require an issue however it is good practice to open up an issue for larger changes. If you are unsure of where to start ask on the slack channel or look at existing issues. The 'good first issue' label marks issues that are particularly good for people new to the codebase.
Changes must adhere to the style guide and this will be verified by the continuous integration build. Java code style is approximately google style and can be checked with checkstyle. Python adheres to the pep8 standard.
Upon submission of a pull request you will be asked to sign our contributor license agreement. We use Reviewable.io for reviews. Anyone can take part in the review process and once the community is happy and the build actions are passing a Pull Request will be merged. Support must be unanimous for a change to be merged.
Please see our Security Policy