aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 02b3e53f5095fc0e226f92824e2b6c671eed364a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Contributing Guide

Thanks for taking the time to contribute. Folks like you are more than welcome!

## I want to suggest something, report a bug, etc.

[Please create an issue](https://github.com/cstate/cstate/issues)!

## I want to write code.

First of all:

**Never merge to master. Merge to dev.**

Some guidelines. You want to make sure that you have:

* Looked, if there was an issue for the thing you are trying to achieve
* If there isn't, create one and discuss your proposal in that issue.

The code you write should be:

+ working as intended,
+ spaced out instead of being in all one big pile,
+ readable to humans. If it is not immediately obvious, add some comments.

## I want to translate

[Read this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations).

## I want to support the project

Please **star, share, and use the software**. Thank you, if you do.

If you wish to support the project financially:

[Sponsor the author @mistermantas on GitHub](https://github.com/sponsors/mistermantas)

[Support the author on PayPal](https://www.paypal.me/mistermantas)