Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.48 KB

CONTRIBUTE.md

File metadata and controls

48 lines (30 loc) · 1.48 KB

Branching strategy : Lite Git flow


Requirements

  • Webstorm (by Jetbrains)
  • Node.js

Coding rules

  • Don't comment a large block of code and leave it in the master branch.
  • Give functional names to methods.
  • If the method comportment is complex to understand add doc.
  • Test all methods before pushing.
  • Don't write methods with useless vars.

Commit pattern

  • Give a name easy to understand. It needs to describe the commit.
  • In commit message, link the commit with the issue at the beginning and add a description if the title is not sufficient.
  • If you forget to link the commit with an issue, go to Github and add the issue number in comment.

Adding new features

  • When we want to add new features (implement milestone's features), we create a new branch to develop it.
  • Don't forget to create tests!.
  • When it's done, cf branch merging rules.

Branch merging

  • To merge a branch with the master branch, you need to create a pull request and wait that all group members approve your demand.

Branches organization

  • New features are stored in "features/" branches, when they are finished and tested, you can merge your branch with the master branch.
  • Before rendering (weekly rendering), launch all tests, and read the code again in group. If everything is good, you can add a tag.
  • Our master branch is a production branch, don't forget the tag to succeed the rendering !