Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

85 lines (57 loc) · 3.53 KB
Raw

Contributing to Nessie

How to contribute

Everyone is encouraged to contribute to this 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 projectnessie.

Please use GitHub issues for bug reports and feature requests and GitHub Pull Requests for code contributions.

More information are available at https://projectnessie.org/develop/

Code of conduct

You must agree to abide by the Project Nessie Code of Conduct.

Reporting issues

Issues can be filed on GitHub. Please add as much detail as possible. Including the version and a reproducer. The more the community knows the more it can help :-)

Feature Requests

If you have a feature request or questions about the direction of the project please as via a GitHub issue.

Large changes or improvements

We are excited to accept new contributors and larger changes. Please post a proposal before submitting a large change. This helps avoid double work and allows the community to arrive at a consensus on the new feature or improvement.

Code changes

Developing changes to the plugins

There are no integration tests in all the plugins in this repository.

To verify that changes to the plugins in this repository work, add an includeBuild() to for example the Nessie's settings.gradle.kts file like this above the pluginManagement section.

// Adjust the path in the includeBuild directive to point to your local clone of the
// gradle-build-plugins repository.
includeBuild("../../gradle-build-plugins/")

pluginManagement {

Development process

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.

Style guide

Changes must adhere to the style guide and this will be verified by the continuous integration build.

Java + Kotlin code style is checked by Spotless with google-java-format during build.

Configuring the Code Formatter for Intellij IDEA and Eclipse

Follow the instructions for Eclipse or IntelliJ, note the required manual actions for IntelliJ.

Automatically fixing code style issues

Java and Kotlin code style issues can be fixed from the command line using ./gradlew spotlessApply.

Submitting a pull request

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.

Reporting security issues

Please see our Security Policy