Skip to content

Commit 97ee6ff

Browse files
author
Boris Malensek
committed
Adds contributing guidelines.
1 parent e61dd2f commit 97ee6ff

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing
2+
3+
We are happy to accept your contributions to make scala-jsonapi better and more awesome!
4+
5+
## Pull requests only
6+
7+
Please do not push to the master branch directly. Always use pull requests and let people discuss changes in the pull request.
8+
Pull requests should only be merged after all discussions have been concluded and at least one reviewer has offered **approval**.
9+
10+
## Guidelines
11+
12+
Here are the guidelines we would liek to follow:
13+
- create a [Github issues](https://github.com/zalando/scala-jsonapi/issues) before submitting a pull request
14+
- use branches named according to issue number with `issue/` prefix (optionally: following with an issue short description) (e.g. `issue/46/this-is-a-new-shiny-issue`)
15+
- code coverage **must not** decrease in a pull request
16+
- keep the current code style

0 commit comments

Comments
 (0)