From d95ad46dc77e6c15e3582cb1b4d0a9f75060da87 Mon Sep 17 00:00:00 2001 From: antoinezanardi Date: Tue, 27 Oct 2020 21:12:56 +0100 Subject: [PATCH] feat(CONTRIBUTORS.md): `CONTRIBUTING.md` file added for helping people to contribute to this awesome project. Closes #39 --- .travis.yml | 4 +-- CHANGELOG.md | 1 + CONTRIBUTING.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- 4 files changed, 82 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.travis.yml b/.travis.yml index 23dbc26..3ea54e8 100644 --- 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 index 0ee93e5..d9ae84d 100644 --- 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 new file mode 100644 index 0000000..75601b4 --- /dev/null +++ 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**: + +``` +(): + + + +