From 43fc15eea80adfdfd3681ecbc26eb9b6fbd350c6 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sun, 6 Oct 2019 11:05:55 +0300 Subject: #81 - Clarify contributing --- CONTRIBUTING.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 328575f..58825c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,13 +6,22 @@ Thanks for taking the time to contribute. Folks like you are more than welcome! Cool, [just 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.** + +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 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). ## Wait, my question has not been answered. -- cgit v1.2.3-70-g09d2