1 | # :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles: :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk:
|
2 |
|
3 | So, you want to contribute to this project! That's awesome. However, before
|
4 | doing so, please read the following simple steps how to contribute. This will
|
5 | make the life easier and will avoid wasting time on things which are not
|
6 | requested. :sparkles:
|
7 |
|
8 | ## Discuss the changes before doing them
|
9 | - First of all, open an issue in the repository, using the [bug tracker][1],
|
10 | describing the contribution you'd like to make, the bug you found or any
|
11 | other ideas you have. This will help us to get you started on the right
|
12 | foot.
|
13 |
|
14 | - If it makes sense, add the platform and software information (e.g. operating
|
15 | system, Node.JS version etc), screenshots (so we can see what you're seeing).
|
16 |
|
17 | - It's recommended to wait for feedback before continuing to next steps. However,
|
18 | if the issue is clear (e.g. a typo) and the fix is simple, you can continue
|
19 | and fix it.
|
20 |
|
21 | ## Fixing issues
|
22 | - Fork the project in your account and create a branch with your fix:
|
23 | `some-great-feature` or `some-issue-fix`.
|
24 |
|
25 | - Commit your changes in that branch, writing the code following the
|
26 | [code style][2]. If the project contains tests (generally, the `test`
|
27 | directory), you are encouraged to add a test as well. :memo:
|
28 |
|
29 | - If the project contains a `package.json` file add yourself in the
|
30 | `contributors` array (if it doesn't exist, create it):
|
31 |
|
32 | ```json
|
33 | {
|
34 | "contributors": [
|
35 | "Your Name <and@email.address> (http://your.website)
|
36 | ]
|
37 | }
|
38 | ```
|
39 |
|
40 | ## Creating a pull request
|
41 |
|
42 | - Open a pull request, and reference the initial issue in the pull request
|
43 | message (e.g. *fixes #<your-issue-number*). Write a good description and
|
44 | title, so everybody will know what is fixed/improved.
|
45 |
|
46 | - If it makes sense, add screenshots, gifs etc, so it's easier to see what's
|
47 | going on.
|
48 |
|
49 | ## Wait for feedback
|
50 | Before accepting your contributions, we will review them. You may get feedback
|
51 | about what should be fixed in your modified code. If so, just keep committing
|
52 | in your branch and the pull request will be updated automatically.
|
53 |
|
54 | ## Everyone is happy!
|
55 | Finally, your contributions will be merged, and everyone will be happy! :smile:
|
56 |
|
57 | Thanks! :sweat_smile:
|
58 |
|
59 | [1]: https://github.com/IonicaBizau/node-is-there/issues
|
60 | [2]: https://github.com/IonicaBizau/code-style |
\ | No newline at end of file |