|
| 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 would 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 are |
| 16 | + seeing). |
| 17 | + |
| 18 | + - It is recommended to wait for feedback before continuing to next steps. |
| 19 | + However, if the issue is clear (e.g. a typo) and the fix is simple, you can |
| 20 | + continue and fix it. |
| 21 | + |
| 22 | +## Fixing issues |
| 23 | + - Fork the project in your account and create a branch with your fix: |
| 24 | + `some-great-feature` or `some-issue-fix`. |
| 25 | + |
| 26 | + - Commit your changes in that branch, writing the code following the |
| 27 | + [code style][2]. If the project contains tests (generally, the `test` |
| 28 | + directory), you are encouraged to add a test as well. :memo: |
| 29 | + |
| 30 | + - If the project contains a `package.json` or a `bower.json` file add yourself |
| 31 | + in the `contributors` array (or `authors` in the case of `bower.json`; |
| 32 | + if the array does not exist, create it): |
| 33 | + |
| 34 | + ```json |
| 35 | + { |
| 36 | + "contributors": [ |
| 37 | + "Your Name <[email protected]> (http://your.website)" |
| 38 | + ] |
| 39 | + } |
| 40 | + ``` |
| 41 | + |
| 42 | +## Creating a pull request |
| 43 | + |
| 44 | + - Open a pull request, and reference the initial issue in the pull request |
| 45 | + message (e.g. *fixes #<your-issue-number>*). Write a good description and |
| 46 | + title, so everybody will know what is fixed/improved. |
| 47 | + |
| 48 | + - If it makes sense, add screenshots, gifs etc., so it is easier to see what |
| 49 | + is going on. |
| 50 | + |
| 51 | +## Wait for feedback |
| 52 | +Before accepting your contributions, we will review them. You may get feedback |
| 53 | +about what should be fixed in your modified code. If so, just keep committing |
| 54 | +in your branch and the pull request will be updated automatically. |
| 55 | + |
| 56 | +## Everyone is happy! |
| 57 | +Finally, your contributions will be merged, and everyone will be happy! :smile: |
| 58 | +Contributions are more than welcome! |
| 59 | + |
| 60 | +Thanks! :sweat_smile: |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | +[1]: https://github.com/IonicaBizau/github-comments/issues |
| 65 | + |
| 66 | +[2]: https://github.com/IonicaBizau/code-style |
0 commit comments