archive-gh-me/gitmoji
1
0
Fork 0
mirror of https://github.com/carloscuesta/gitmoji.git synced 2026-01-18 16:27:23 +00:00
Code Issues Projects Releases Wiki Activity
gitmoji/.github/CONTRIBUTING.md
Carlos Cuesta 18852ce299
♻️ Move website to Next.js (#368) 
This commit updates the stack of the gitmoji website to Next.js. This was a thing I wanted to do a long time ago.

Our current stack was a little bit outdated and had issues with the Developer UX. The concept is the same, the whole site is built into a Static HTML site.

Also we can benefit from using React ⚛️ ❤️

The current stack will be:

Next.js
React
Flow
Scss
Prettier
Jest
2019-10-26 18:00:59 +02:00

2.0 KiB
Raw Blame History

Contributing to gitmoji

Hello!

Thanks for contributing on gitmoji. Before implementing new features and changes, feel free to submit an issue. We're going to talk 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. Commit your changes. Don't forget to add a commit title with an emoji and a description.
  5. Push your changes.
  6. Submit your pull request.

How to add a gitmoji

  1. Open the gitmojis.json file located at src/data/gitmojis.json.
  2. Add your emoji using the following code inside of the gitmojis array []:
  3. Save the file and create a pull request.
{
  "emoji": "",
  "entity": "entity (Ex: &#x1F440)",
  "code": ":code:",
  "description": "Enter the description for the gitmoji.",
  "name": "code (same as code but without ':' replace underscores for dashes _ => - )"
}

If you want to find the hexadecimal entity of icon, search for it in this site: http://graphemica.com/

Then, after that you'll need to add a new color to the vars.scss file.

You must follow the convention of adding a new item to the $gitmojis array. That matches the name that you added at the json file.

How to start gitmoji

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 task.
$ yarn install && yarn run dev

The project is built with Next.js and SCSS