This repository was archived by the owner on Oct 24, 2020. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +55
-0
lines changed Expand file tree Collapse file tree 1 file changed +55
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contributing guide
2+
3+ ## Legal
4+
5+ All original contributions to Doma are licensed under
6+ the ASL - [ Apache License, version 2.0] ( https://www.apache.org/licenses/LICENSE-2.0 ) or later.
7+
8+ ## Reporting an issue
9+
10+ This project uses GitHub issues to manage the issues. Open an issue directly in GitHub.
11+
12+ Write the issue in English to share it with many people.
13+
14+ ## Before you contribute
15+
16+ To contribute, use GitHub Pull Requests, from your own fork.
17+
18+ ## Setup
19+
20+ - Install Git and configure your GitHub access
21+ - Install JDK 11
22+ - We recommend that you use [ SDKMAN] ( https://sdkman.io/jdks ) to get JDKs
23+ - Install GraalVM if you build a native executable
24+
25+ ### Build
26+
27+ Clone the repository and navigate to the root directory.
28+ Then run the Gradle ` build ` task:
29+
30+ ```
31+ $ git clone https://github.com/domaframework/doma-quarkus.git
32+ $ cd doma-quarkus
33+ $ ./mvnw install
34+ ```
35+
36+ ### IDE
37+
38+ #### IntelliJ IEDA
39+
40+ Import the root directory as a Maven project.
41+
42+ ### Code Style
43+
44+ We use [ spotless] ( https://github.com/diffplug/spotless ) and
45+ [ google-java-format] ( https://github.com/google/google-java-format ) 1.7 for code formatting.
46+
47+ To format, just run Maven as follows:
48+
49+ ```
50+ $ ./mvnw spotless:apply
51+ ```
52+
53+ To run google-java-format in your IDE,
54+ see https://github.com/google/google-java-format#using-the-formatter .
55+
You can’t perform that action at this time.
0 commit comments