All original contributions to Doma are licensed under the ASL - Apache License, version 2.0 or later.

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

Write the issue in English to share it with many people.

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

• Install Git and configure your GitHub access
• Install JDK 21
  • We recommend that you use SDKMAN to get JDKs

Clone the repository and navigate to the root directory. Then run the Gradle build task:

$ git clone https://github.com/domaframework/doma.git
$ cd doma
$ ./gradlew build

Instead of building Doma from the master branch, you may want to use snapshots. To use snapshots, define a Maven repository in your build.gradle as follows:

repositories {
    maven {url 'https://oss.sonatype.org/content/repositories/snapshots/'}
}

Snapshots are published when each pull request is merged into the master branch. You can check the last publication date here:

• https://oss.sonatype.org/content/repositories/snapshots/org/seasar/doma/

Import the root directory as a Gradle project.

We use spotless and google-java-format for code formatting.

To format, just run the Gradle build task:

$ ./gradlew build

To run google-java-format in your IDE, see https://github.com/google/google-java-format#using-the-formatter.

See https://github.com/domaframework/doma-docs