1 | # Contributing to Sideral JS
|
2 |
|
3 | Many thanks for contributing to its development. The following is a quick set of guidelines designed to maximise your contribution's effectiveness.
|
4 |
|
5 | ## Prerequisites
|
6 |
|
7 | To be able to contribute on SGR project, you will need :
|
8 |
|
9 | - NodeJS (v6.0)
|
10 | - ESLint
|
11 | - Commitizen
|
12 |
|
13 | ## How the project view works
|
14 |
|
15 | In the [project view](https://github.com/js-republic/sideral/projects/1), you can see four columns : *Ideation* -> *Todos* -> *Work in progress* -> *Done*
|
16 |
|
17 | - *Ideation* : Is the step where Epics are debated. The Epic come from the core team or are voted on [Feathub](http://feathub.com/js-republic/sideral).
|
18 | An Epic will list all stories attached to him.
|
19 | - *Todos* : In this step, the epics, and the stories a defined and wait for contributor (maybe you :tada:).
|
20 | If someone wants work on a story, it can add a comment on it and core team will pass the story in next column.
|
21 | - *Work in progress* : Contains all stories currently developed. To be done, each story must be implemented in a pull-request, have well designed commit history, covered by unit tests and finally submit and reviewed by the core commiter team.
|
22 | - *Done* : The final step, this column contains all finished stories
|
23 |
|
24 | ## Pull requests
|
25 |
|
26 | All pull requests are welcome. You should create a new branch, based on the **master branch**, and submit the PR against the **dev branch**.
|
27 |
|
28 | Your branch name must be explicit like this : feature/componentWeather. All development branch must starts with feature/yourFeature and must be a reference to an issue.
|
29 |
|
30 | **Your branch must have unit tests ! All PR without Unit test will not be accepted.**
|
31 |
|
32 | Before submitting, run `yarn run build` to ensure the build passes.
|
33 |
|
34 | ## Conventions of code
|
35 |
|
36 | - Use tabs instead of spaces
|
37 | - Dont forget semicolons after each instructions
|
38 | - Use single quotes for strings
|
39 | - Use only camelCase
|
40 |
|
41 | Above all, code should be clean and readable, and commented where necessary. |
\ | No newline at end of file |