Skip to content

Commit 79c9fc4

Browse files
Add CONTRIBUTING.md
1 parent 3f3caa6 commit 79c9fc4

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
This project uses a very minimalistic approach to contributions:
4+
5+
* Fork it
6+
* Create a branch
7+
* Make your changes
8+
* Commit it with an explanation of [*why* this change is necessary](https://chris.beams.io/posts/git-commit/#why-not-how)
9+
* Make sure all tests pass
10+
* Submit a pull request
11+
* Be patient
12+
13+
## Prerequisites
14+
15+
This project uses Gradle 6.x. A [compatible JDK version](https://docs.gradle.org/current/userguide/compatibility.html#java) is therefore required.
16+
17+
## Running Tests
18+
19+
To start a local MongoDB node before running tests, use
20+
21+
``` shell
22+
./gradlew startMongoDb
23+
```
24+
25+
Then run the tests:
26+
27+
``` shell
28+
./gradlew check
29+
```

0 commit comments

Comments
 (0)