Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 1.72 KB

Contributing guide

Legal

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

Reporting an issue

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.

Before you contribute

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

Setup

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

Build

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

Using snapshots

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:

IDE - IntelliJ IDEA

Import the root directory as a Gradle project.

Code Style

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.

Documentation

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