Skip to content

Commit 7ee2370

Browse files
authored
docs: adding contributing documentation (#35)
1 parent 6aaff9f commit 7ee2370

2 files changed

Lines changed: 68 additions & 1 deletion

File tree

.github/pull_request_template.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Pull Request
2+
3+
<!--
4+
Please make sure to have read the CONTRIBUTING.md guidelines.
5+
-->
6+
7+
## Description
8+
9+
<!--
10+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
11+
12+
Fixes # (issue)
13+
-->
14+
15+
## Type of change
16+
17+
<!--
18+
Please delete options that are not relevant.
19+
-->
20+
21+
- [ ] Bug fix (non-breaking change which fixes an issue)
22+
- [ ] New feature (non-breaking change which adds functionality)
23+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
24+
- [ ] Documentation update
25+
26+
## How Has This Been Tested?
27+
28+
<!--
29+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
30+
-->
31+
32+
- [ ] Test A
33+
- [ ] Test B
34+
35+
<!--
36+
## Checklist:
37+
38+
- [ ] My code follows the style guidelines of this project
39+
- [ ] I have performed a self-review of my own code
40+
- [ ] I have commented my code, particularly in hard-to-understand areas
41+
- [ ] I have made corresponding changes to the documentation
42+
- [ ] My changes generate no new warnings
43+
- [ ] I have added tests that prove my fix is effective or that my feature works
44+
- [ ] New and existing unit tests pass locally with my changes
45+
- [ ] Any dependent changes have been merged and published in downstream modules
46+
-->

CONTRIBUTING.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Contribution Guidelines
22

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+
314
## Code Style
415

516
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
@@ -15,4 +26,14 @@ npm install prettier-plugin-kotlin --save-dev
1526

1627
Subsequently, IntelliJ IDEA can be configurated to use Prettier for formatting Java and Kotlin files. For this, you can use the
1728
[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
39+
generate the changelogs.

0 commit comments

Comments
 (0)