Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

31 lines (24 loc) · 1.52 KB
Raw

Contributing

Contributions are very welcome. The following will provide some helpful guidelines.

Gradle CPD plugin Contributor License Agreement

  • You will only submit contributions where you have authored 100% of the content.
  • You will only submit contributions to which you have the necessary rights. This means in particular, that if you are employed you have received the necessary permissions from your employer to make the contributions.
  • Whatever content you contribute will be provided under the project license(s) (see "LICENSE.txt")

How to contribute

We love pull requests. Here is a quick guide:

  1. You need to have a JDK (at least version 11) installed.
  2. Fork the repo (see https://help.github.com/articles/fork-a-repo).
  3. Create a new branch from master.
  4. Ensure that you have a clean state by running ./gradlew clean build.
  5. Add your change together with a test (tests are not needed for refactorings and documentation changes).
  6. Run ./gradlew clean build again and ensure all tests are passing.
  7. Push to your fork/branch and submit a pull request.
  8. Add the following line to your Pull Request description:
I hereby agree to the terms of the Gradle CPD plugin Contributor License Agreement.
  1. Now you are waiting on us. We review your pull request and at least leave some comments.

Note: If you are thinking of providing a fix for one of the bugs or feature requests, it is usually a good idea to add a comment to the bug to make sure that there is agreement on how we should proceed.