Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.34 KB

contribute.md

File metadata and controls

40 lines (26 loc) · 1.34 KB
Raw

Geotrek-rando documentation

‹ Back to README

Contribute

Workflow

Git

master is the main developpement branch, but don't commit directly into it, and don't merge it back into your development branch.

Always start by creating your own fork of the repository (origin should point to your fork, and upstream should be a reference to main Geotrek-rando repository).

For each development you do, create a dedicated branch from the tip of master, and rebase your branch before creating your pull request (and each time you edit it).

Coding conventions / styles

Javascript

In the root directory of the project is a file named .eslintrc.js which gives the main rules that all javascript files have to follow.

But here comes some common rules :

  • Use 4 space indents
  • Always use strict mode
  • Use single quotes ' for strings
  • Always use strict equality operators (==== & !==)
  • Always put curly braces around blocks (loops and conditionals)
  • Line break immediately after opening curly braces, and before closing it.

SCSS

  • Use 4 space indents
  • Line break immediately after opening curly braces, and before closing it.