@@ -0,0 +1,53 @@
1+# Contributing to the Kowainik repositories
2+
3+## :wave: Greetings Traveler!
4+
5+We are delighted you're reading this, and we appreciate the effort you're
6+taking to make our projects awesome! :sparkles:
7+
8+## How to contribute
9+
10+### :bug: Report bugs or feature request :bulb:
11+
12+If you discover a bug or have any proposals on how to make this project better
13+don't hesitate to create an issue [here](../../issues/new) in a free format.
14+
15+### Create a PR
16+
17+We love to receive pull requests from everyone! It's usually a good idea
18+to tell about your intention to work on something under the corresponding
19+issue, so everyone is aware that you're on it. If there's no such issue — simply
20+create a new one!
21+
22+To get started with the Pull Request implementation you should first
23+[fork](../../fork), then clone the repo:
24+
25+ git clone git@github.com:your-username/project-name.git
26+
27+Make your changes and consider the following checklist to go through
28+before submitting your pull request.
29+
30+### :white_check_mark: Check list
31+- [ ] New/fixed features work as expected (Bonus points for the new tests).
32+- [ ] There are no warnings during compilation.
33+- [ ] `hlint .` output is: _No Hints_ (see [`hlint`][hlint] tool docs).
34+- [ ] The code is formatted with the [`stylish-haskell`][stylish-tool] tool
35+ using [stylish-haskell.yaml][stylish] file in the repository.
36+- [ ] The code style of the files you changed is preserved (for more specific
37+ details on our style guide check [this document][style-guide]).
38+- [ ] Commit messages are in the proper format.
39+ Start the first line of the commit with the issue number in square parentheses.
40+
41+ **_Example:_** `[#42] Upgrade upper bounds of 'base'`
42+
43+After all above is done commit and push to your fork.
44+Now you are ready to [submit a pull request](../../compare).
45+
46+
47+----------
48+Thanks for spending your time on reading this contributing guide! :sparkling_heart:
49+
50+[stylish]: .stylish-haskell.yaml
51+[stylish-tool]: http://hackage.haskell.org/package/stylish-haskell
52+[hlint]: http://hackage.haskell.org/package/hlint
53+[style-guide]: https://github.com/kowainik/org/blob/master/style-guide.md#haskell-style-guide