archive-gh-me/gitmoji
1
0
Fork 0
mirror of https://github.com/carloscuesta/gitmoji.git synced 2025-12-08 20:14:12 +00:00
Code Issues Projects Releases Wiki Activity
gitmoji/.github/CONTRIBUTING.md
Carlos Cuesta 7d305f45f3
♻️ Migrate from yarn to pnpm (#1503) 
* 🔧 Add `pnpm-workspace` configuration

* 🔧 Add `pnpm-lock` file

* ♻️ Replace `yarn` with `pnpm` in root package.json

* 🔥 Remove yarn binary

* ⬆️ Bump `next-pwa` dependencies

* 🔥 Remove yarn lockfile

* ♻️ Replace `yarn` with `pnpm` in gitmojis package

* ♻️ Replace `yarn` with `pnpm` in website package

* ♻️ Replace `yarn` with `pnpm` in GitHub workflows

* ♻️ Adjust `lintstagedrc` prettier arguments

* 📝 Update documentation

* ♻️ Replace `yarn` with `pnpm` in git hooks

* 🔥 Remove yarn refs from git files

* ⬆️ Update `clipboard` dependency

* 👷‍♂️ Install pnpm in GitHub Actions

* 🔥 Remove unnecessary `exec` c md

* 📝 Update documentation

* 🔧 Specify pnpm as an engine
2023-06-14 18:18:53 +02:00

2.4 KiB
Raw Blame History

Contributing to gitmoji

Hello!

Thanks for contributing on gitmoji. Before implementing new features and changes, please submit an issue. We will discuss here! 😜.

If you would like to add a new emoji to gitmoji, fill the provided ISSUE_TEMPLATE when creating an issue and take a look at the contributing section.

How to submit a pull request?

  1. Fork this repository.
  2. Create a new branch with the feature name. (Eg: add-emoji-deploy, fix-website-header)
  3. Make your changes.
  4. Test you changes by running pnpm turbo test
    • 4.1. If the snapshots are failing run pnpm turbo test -- -u and be sure that the new snapshots match your changes
  5. Commit your changes. Don't forget to add a commit title with an emoji and a description.
  6. Push your changes.
  7. Submit your pull request.

How to add a gitmoji

  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 file. Matching the name you added at the JSON file.
  4. Save the file and create a pull request.
{
  "emoji": "",
  "entity": "entity (Ex: &#x1F440)",
  "code": ":code:",
  "description": "Enter the description for the gitmoji. Use present form for verbs.",
  "name": "code (same as code but without ':' replace underscores for dashes _ => - )",
  "semver": "The semantic versioning effect (can be `'major'`, `'minor'`, `'patch'` or `null` if the commit has no effect on the version)"
}

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!

How to start the website

If you want to make changes to the site, follow the next steps:

  1. Clone gitmoji
$ git clone https://github.com/carloscuesta/gitmoji.git
$ cd gitmoji
  1. Install the dependencies and start the development server.
$ pnpm install && pnpm run dev

The project is built with Next.js