Skip to content

Commit 849f1e2

Browse files
committed
Update contributing guidelines to include testing and Doma dependency management
1 parent 56c2b2c commit 849f1e2

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ You can install these plugins from `File > Settings > Plugins` in IntelliJ IDEA.
3939
- **[Plugin DevKit](https://plugins.jetbrains.com/plugin/22851-plugin-devkit)**
4040
- **[PsiViewer](https://plugins.jetbrains.com/plugin/227-psiviewer)**
4141
- **[Spotless Gradle](https://plugins.jetbrains.com/plugin/18321-spotless-gradle)**
42+
- **[Ktlint](https://plugins.jetbrains.com/plugin/15057-ktlint)**
4243

4344
## Setting Up the Development Environment
4445

@@ -73,9 +74,17 @@ You can install these plugins from `File > Settings > Plugins` in IntelliJ IDEA.
7374
```sh
7475
./gradlew runIde
7576
```
77+
78+
## Testing and Doma Dependency Management
79+
80+
When running tests, the plugin creates a virtual project environment with the required Doma dependencies.
81+
82+
- The Doma jar files for each version used in tests are located in the [`src/test/lib`](src/test/lib) directory.
83+
- The dependencies for the virtual project are managed in the `setUp()` method of [`DomaSqlTest`](src/test/kotlin/org/domaframework/doma/intellij/DomaSqlTest.kt).
84+
7685
## Code Style
7786
78-
We use [Spotless](https://github.com/diffplug/spotless) and [google-java-format](https://github.com/google/google-java-format) for code formatting and style checking.
87+
We use [spotless](https://github.com/diffplug/spotless) and [google-java-format](https://github.com/google/google-java-format) for code formatting and style checking.
7988
8089
- To check or apply formatting, run the following Gradle tasks:
8190
```sh
@@ -89,9 +98,21 @@ We use [Spotless](https://github.com/diffplug/spotless) and [google-java-format]
8998
9099
Please ensure your code is formatted with Spotless before submitting a pull request.
91100
101+
### Code Inspection
102+
103+
For advanced code inspection and static analysis, consider using [Qodana](https://www.jetbrains.com/qodana/).
104+
105+
- Qodana is a static analysis tool by JetBrains that can automatically check code quality in CI pipelines.
106+
- This repository includes a [`qodana.yml`](qodana.yml) file as an example configuration for Qodana.
107+
- For more details, refer to the [Qodana official documentation](https://www.jetbrains.com/help/qodana/).
108+
92109
## Branch Naming Rules
93110
94-
When creating a working branch, please follow the naming rules below according to the type of change:
111+
When creating a working branch, please follow the naming rules below according to the type of change.
112+
113+
These branch paths are used to categorize pull requests by label when automatically creating release drafts.
114+
115+
The mapping between branch paths and label names is configured in [`release-drafter.yml`](.github/release-drafter.yml).
95116
96117
- Bug fixes: `fix/`
97118
- Documentation changes: `document/`
@@ -110,3 +131,4 @@ For example, a bug fix branch might be named `fix/typo-in-readme`, and a new fea
110131
./gradlew check
111132
```
112133
3. Submit a pull request with a clear description of your changes.
134+
4. After creating a pull request, please link any related issues to the PR.

0 commit comments

Comments
 (0)