feat(CONTRIBUTORS.md): CONTRIBUTING.md file added for helping peopl…

…e to contribute to this awesome project. Closes #39
antoinezanardi · Oct 27, 2020 · d95ad46 · d95ad46
1 parent 208182d
commit d95ad46
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 3 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -12,12 +12,12 @@ before_install:
   openssl aes-256-cbc -K $encrypted_e4b94ab10d0b_key -iv $encrypted_e4b94ab10d0b_iv -in deploy/deploy-key.enc -out deploy/deploy-key -d
 deploy:
     - provider: script
-      clean: false
+      skip_cleanup: true
       script: bash ./deploy/deploy-production.sh
       on:
         branch: master
     - provider: script
-      clean: false
+      skip_cleanup: true
       script: bash ./deploy/deploy-sandbox.sh
       on:
         branch: staging
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### 🚀 New features
 
+* [#39](https://github.com/antoinezanardi/werewolves-assistant-web/issues/39) - `CONTRIBUTING.md` file added for helping people to contribute to this awesome project.
 * [#49](https://github.com/antoinezanardi/werewolves-assistant-web/issues/49) - New role picker in the game lobby with all data about the role (max in game, description and more...).
 * [#51](https://github.com/antoinezanardi/werewolves-assistant-web/issues/51) - All role images are loaded from the API.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,78 @@
+# 🌟 Contributing
+
+You want to contribute to this project, and we're thankful for that ❤. But first, please be sure to read the contribution guidelines before making or requesting a change.
+
+## 🤝 How To Contribute
+
+1. [**Fork**](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) the project.
+2. Create a new topic branch on your local forked copy. Its name must be in lowercase and explicit.
+3. Push your topic branch up to your fork. Don't forget to add [**tests**](https://github.com/antoinezanardi/werewolves-assistant-web/tree/master/tests) and update [**the CHANGELOG.md file**](https://github.com/antoinezanardi/werewolves-assistant-web/blob/master/CHANGELOG.md) accordingly. Please read the ESLint rules and the commit messages format in the dedicated sections below.
+4. [**Open a Pull Request**](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests) with a clear title and description against the `staging` branch.
+
+## ✅ ESLint rules
+
+In order to keep the code clean, consistent and free of bad JS practises, **[ESLint](https://eslint.org/)** is installed with nearly **320 rules activated** !
+
+Complete list of all enabled rules is available in the **[.eslintrc.js file](https://github.com/antoinezanardi/werewolves-assistant-web/blob/master/.eslintrc.js)**.
+
+All pull requests containing code which doesn't respect those rules won't be accepted.
+
+## 🆕 Commit Messages
+
+Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special format that includes a **type**, a **scope**, and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory, and the **scope** of the header is optional as of **body** and **footer**.
+
+Any line of the commit message cannot be longer 100 characters ! This allows the message to be easier to read on GitHub as well as in various git tools.
+
+#### Revert
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
+In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+#### Type
+Must be one of the following:
+
+* **feat**: A new feature.
+* **fix**: A bug fix.
+* **docs**: Documentation only changes.
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
+* **refactor**: A code change that neither fixes a bug nor adds a feature.
+* **perf**: A code change that improves performance.
+* **test**: Adding missing or correcting existing tests.
+* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation.
+
+#### Scope
+The scope could be anything specifying place of the commit change. For example `Users`, `Games`, `CI`, `Players`, `Helpers`, etc...
+
+You can use `*` when the change affects more than a single scope.
+
+#### Subject
+The subject contains succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* don't capitalize first letter
+* no dot (.) at the end
+
+#### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+#### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to
+[reference GitHub issues that this commit closes][closing-issues].
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
+The rest of the commit message is then used for this.
+
+A detailed explanation can be found in this [document][commit-message-format].
+
+[angular-contributing]: https://raw.githubusercontent.com/angular/angular.js/master/CONTRIBUTING.md
+[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ Current release on **main version** is [![GitHub release](https://img.shields.io
 ###### 🏷️ <a href="https://github.com/antoinezanardi/werewolves-assistant-web/releases" target="_blank">All releases for this project are available here</a>. 
 
 ## ☑️ Code analysis and consistency
-In order to keep the code clean, consistent and free of bad JS practises, **[ESLint](https://eslint.org/)** is installed with nearly **313 rules activated** !
+In order to keep the code clean, consistent and free of bad JS practises, **[ESLint](https://eslint.org/)** is installed with nearly **320 rules activated** !
 
 Complete list of all enabled rules is available in the **[.eslintrc.js file](https://github.com/antoinezanardi/werewolves-assistant-web/blob/master/.eslintrc.js)**.