diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b6296b..67cf76c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,16 +7,17 @@ requested. :sparkles: ## Discuss the changes before doing them - First of all, open an issue in the repository, using the [bug tracker][1], - describing the contribution you'd like to make, the bug you found or any + describing the contribution you would like to make, the bug you found or any other ideas you have. This will help us to get you started on the right foot. - If it makes sense, add the platform and software information (e.g. operating - system, Node.JS version etc), screenshots (so we can see what you're seeing). + system, Node.JS version etc.), screenshots (so we can see what you are + seeing). - - It's recommended to wait for feedback before continuing to next steps. However, - if the issue is clear (e.g. a typo) and the fix is simple, you can continue - and fix it. + - It is recommended to wait for feedback before continuing to next steps. + However, if the issue is clear (e.g. a typo) and the fix is simple, you can + continue and fix it. ## Fixing issues - Fork the project in your account and create a branch with your fix: @@ -26,13 +27,14 @@ requested. :sparkles: [code style][2]. If the project contains tests (generally, the `test` directory), you are encouraged to add a test as well. :memo: - - If the project contains a `package.json` file add yourself in the - `contributors` array (if it doesn't exist, create it): + - If the project contains a `package.json` or a `bower.json` file add yourself + in the `contributors` array (or `authors` in the case of `bower.json`; + if the array does not exist, create it): ```json { "contributors": [ - "Your Name (http://your.website) + "Your Name (http://your.website)" ] } ``` @@ -40,11 +42,11 @@ requested. :sparkles: ## Creating a pull request - Open a pull request, and reference the initial issue in the pull request - message (e.g. *fixes #*). Write a good description and title, so everybody will know what is fixed/improved. - - If it makes sense, add screenshots, gifs etc, so it's easier to see what's - going on. + - If it makes sense, add screenshots, gifs etc., so it is easier to see what + is going on. ## Wait for feedback Before accepting your contributions, we will review them. You may get feedback @@ -53,8 +55,10 @@ in your branch and the pull request will be updated automatically. ## Everyone is happy! Finally, your contributions will be merged, and everyone will be happy! :smile: +Contributions are more than welcome! Thanks! :sweat_smile: [1]: https://github.com/IonicaBizau/git-stats/issues + [2]: https://github.com/IonicaBizau/code-style \ No newline at end of file