diff options
| author | Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> | 2019-12-21 21:25:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-21 21:25:21 +0200 |
| commit | a8f60c31b75fe5a3c91a6595585738523f1cad25 (patch) | |
| tree | 7528a3042e37765e286c9490f5b321e6799acb41 /CONTRIBUTING.md | |
| parent | 96394ffb854ec6b8f17aa1ef105eb9ff92e5e676 (diff) | |
| parent | 12e885ad58d44d55603a64906d1dcf7f1d961b4c (diff) | |
cState v4.0 Final (#82)
cState v4.0 Final
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 328575f..02b3e53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,16 +4,35 @@ Thanks for taking the time to contribute. Folks like you are more than welcome! ## I want to suggest something, report a bug, etc. -Cool, [just create an issue](https://github.com/cstate/cstate/issues)! +[Please create an issue](https://github.com/cstate/cstate/issues)! -## I want to help contribute a new feature. +## I want to write code. -Great. Here are some things to keep in mind: +First of all: -+ Keep it as simple as possible. -+ Keep it as light as possible. -+ Try to make it readable. +**Never merge to master. Merge to dev.** -## Wait, my question has not been answered. +Some guidelines. You want to make sure that you have: -At the time of writing, cState is such a small project that anyone contributing would be a downright miracle. However, if you are a miracle worker, please do redirect any concerns and they will addressed as soon as humanely possible. [Just create an issue](https://github.com/cstate/cstate/issues)! +* 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)
\ No newline at end of file |