GUIDELINES FOR DEVELOPMENT

1 minute read

This project is prone to be developped by several developpers, so we agreed on some basic rules…

GENERAL

we try to comment and document in english
check out our “project” boards board to have an idea about the priorities we collectively decided to work on
“see something, say something” : open new issues when you see problems to solve
document your own issues with everything you have : images, references, snippets, etc…
we update the README.md and the GUIDELINES_DEV.md directly on github
for the markdown files try to follow those advices…

We are following this git principles : link to blog. In brief :

there are 2 main branches : master and develop
new features must be code reviewed and then (if accepted) pulled into the branch develop
once every new feature is accepted and merged into develop, develop must be merged into master to constitute a new release

Please follow those rules when developping new features :

locally : create a new branch to work on your own feature(s) named like mypseudo_mynewfeature
before pushing your changes pull the remote develop branch to be merged with your changes in mypseudo_mynewfeature branch (so to be sure the features you just developped are compatible with the checked/reviewed develop branch):
```
git pull origin develop
```
then push your branch to the remote repo (github repo) :
```
git push origin <mypseudo_mynewfeature>
```
ask for a pull request on Github from mypseudo_mynewfeature to develop
someone else must be assigned as a code reviewer, whose in charge to accept your code changes and merge
once accepted / reviewed delete mypseudo_mynewfeature from repo to keep the branches clean