From 305f13371e3bf5ae5791e461f12562818a460b36 Mon Sep 17 00:00:00 2001 From: Vytor Calixto <vytorcalixto@gmail.com> Date: Tue, 4 Oct 2016 12:10:23 -0300 Subject: [PATCH] [ci skip] :memo: Update CONTRIBUTING.md --- CONTRIBUTING.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5941408e..52f768b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,4 +16,32 @@ Bugs are reported and tracked at simcaq/SCRUM repository. As you determinate whi * **master**: protected branch and contains the stable version * **development**: default branch * **issue/??**: issue branch - a branch created to solve a issue -* **feature_????**: feature branch - a branch created to add a feature \ No newline at end of file +* **feature_????**: feature branch - a branch created to add a feature + +## Styleguide + +### Commit messages + +* Use the present tense ("Add feature" not "Added feature") +* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") +* Limit the first line to 72 characters or less +* Reference issues and pull requests liberally +* When only changing documentation, include [ci skip] in the commit description +* Consider starting the commit message with an applicable emoji: + * :art: `:art:` when improving the format/structure of the code + * :racehorse: `:racehorse:` when improving performance + * :memo: `:memo:` when writing docs + * :bug: `:bug:` when fixing a bug + * :fire: `:fire:` when removing code or files + * :green_heart: `:green_heart:` when fixing the CI build + * :white_check_mark: `:white_check_mark:` when adding tests + * :lock: `:lock:` when dealing with security + * :arrow_up: `:arrow_up:` when upgrading dependencies + * :arrow_down: `arrow_down` when downgrading dependencies + +### JavaScript Styleguide + +All JavaScript follows the AirBnB styleguide with the following modifications: +* 4 spaces of identation +* No unused vars +* Allow param reassign -- GitLab