Thank you for considering making a contribution to Gradle Kotlin DSL! This guide explains how to setup your environment for Gradle Kotlin DSL development and where to get help if you encounter trouble.
In order to make changes to Gradle, you'll need:
- A text editor or IDE. We use and recommend the very latest IntelliJ IDEA CE.
- A Java Development Kit (JDK) version 1.8 or higher
- git and a GitHub account
Gradle Kotlin DSL uses a pull request model for contributions. Fork gradle/kotlin-dsl and clone your fork. Active development happens in the develop branch, so make sure you check out this branch after cloning the repository.
Configure your Git username and email with
git config user.name 'First Last'
git config user.email user@example.com
Before importing the project into IntelliJ IDEA make sure to run ./gradlew check at least once so all required files are generated.
After making changes, you can test them by running ./gradlew check.
To try out a change in behavior manually, use the Gradle distribution from ./build/custom, just make sure to stop all Gradle daemons before using it (./gradlew --stop).
You can debug Gradle by adding -Dorg.gradle.debug=true when executing. Gradle will wait for you to attach at debugger at localhost:5005 by default. We recommend disabling the Gradle Daemon when debugging (--no-daemon).
If you run into any trouble, please reach out to us in the #gradle channel of the public Kotlin Slack instance.
The commit messages that accompany your code changes are an important piece of documentation, and help make your contribution easier to review. Please consider reading How to Write a Git Commit Message. Minimally, follow these guidelines when writing commit messages.
- Keep commits discrete: avoid including multiple unrelated changes in a single commit
- Keep commits self-contained: avoid spreading a single change across multiple commits. A single commit should make sense in isolation
- If your commit pertains to a GitHub issue, include (
See #123) in the commit message on a separate line - Sign off your Git commits to indicate that you agree to the terms of Developer Certificate of Origin.
All code contributions should be submitted via a pull request from a forked GitHub repository.
Once received, the pull request will be reviewed by a Gradle Kotlin DSL developer.
We deeply appreciate your effort toward improving Gradle. If you enjoyed this process, perhaps you should consider getting paid to develop Gradle?