From f9d17affd77030a8a86bcc7df4d5d7b905514132 Mon Sep 17 00:00:00 2001 From: Carlos Cuesta Date: Thu, 22 Dec 2022 09:49:43 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20contributing=20guide?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/CONTRIBUTING.md | 10 +++++----- CODE_OF_CONDUCT.md | 22 +++++++++++----------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9c603c52e1..a5a8309bbf 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -19,9 +19,9 @@ If you would like to add a new emoji to gitmoji, fill the provided `ISSUE_TEMPLA ## How to add a gitmoji -1. Open the **gitmojis.json** file located at `src/data/gitmojis.json`. +1. Open the **gitmojis.json** file located at `packages/gitmojis/src/gitmojis.json`. 2. Add your emoji using the following code inside of the `gitmojis array []`: -3. Add a new color to [the emojiColorsMap.js](https://github.com/carloscuesta/gitmoji/blob/master/src/components/GitmojiList/emojiColorsMap.js) file. Matching the name you added at the JSON file. +3. Add a new color to [the emojiColorsMap.js](https://github.com/carloscuesta/gitmoji/blob/master/packages/website/src/components/GitmojiList/emojiColorsMap.js) file. Matching the name you added at the JSON file. 4. Save the file and create a pull request. ```json @@ -37,9 +37,9 @@ If you would like to add a new emoji to gitmoji, fill the provided `ISSUE_TEMPLA If you want to find the hexadecimal entity of icon, search for it in this site: http://graphemica.com/ -Every suggestion will be reviewed carefully, ⚠️ take into account that not every suggestion will be accepted! +Every suggestion will be reviewed carefully, ⚠️ take into account that not every suggestion will be accepted! -## How to start gitmoji +## How to start the website If you want to make changes to the site, follow the next steps: @@ -50,7 +50,7 @@ $ git clone https://github.com/carloscuesta/gitmoji.git $ cd gitmoji ``` -2. Install the dependencies and start the development task. +2. Install the dependencies and start the development server. ```bash $ yarn install && yarn run dev diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e2d90db91d..f6fdcd26bd 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an +standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within