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 8de7f4cf33
📝 ✅ Update contributing docs, add more tests 
Add a jsonlint to validate gitmojis.json against a JSON Schema. This will ensure that the JSON file is well structured and with all the required fields, update package.json script to add jsonvalidate script.
2016-11-01 16:12:22 +01:00

1.1 KiB
Raw Blame History

Contributing to gitmoji

Hello!

Thanks for 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 gitmoji.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": "",
	"code": ":code:",
	"description": "Enter the description for the gitmoji."
}