You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,16 @@
1
1
# Contribution Guidelines
2
2
3
+
For contributing, please refer to the guidelines below.
4
+
5
+
## Development Setup
6
+
7
+
We highly recommend using IntelliJ IDEA for development. Opening the project in IntelliJ IDEA will automatically configure the project for
8
+
development.
9
+
10
+
Additionally, we highly recommend using the [Pkl IntellJ Plugin](https://pkl-lang.org/intellij/current/index.html) to provide syntax
11
+
highlighting and general support for Pkl files. Using this plugin, the provided CSML Pkl unit tests will automatically correctly import
12
+
the CSM package provided by the project.
13
+
3
14
## Code Style
4
15
5
16
This project uses the opinionated Prettier code formatter. The [Prettier Java](https://github.com/jhipster/prettier-java) plugin is used to format Java code. The Prettier
Subsequently, IntelliJ IDEA can be configurated to use Prettier for formatting Java and Kotlin files. For this, you can use the
17
28
[File Watchers](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin inside IntelliJ IDEA. After installing the plugin, you can add a new file watcher for Prettier or import the
18
-
provided `watchers.xml` file. File Watchers can be configured to run on save inside the _Tools → Actions on Save_ menu.
29
+
provided `watchers.xml` file. File Watchers can be configured to run on save inside the _Tools → Actions on Save_ menu.
30
+
31
+
## Pull Requests
32
+
33
+
We accept pull requests for bug fixes and new features from forks. Please make sure to add unit tests for your changes. The CI will
34
+
automatically build and test your changes.
35
+
36
+
Make sure that your both the commits in your pull request and the pull request title are formatted according to the
37
+
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. Commit linting is enforced by the CI. Squashed commits
38
+
upon merging are also enforced by the CI and will receive the pull request title as the commit message. We use Conventional Commits to
0 commit comments