Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.55 KB

CONTRIBUTING

Thanks for thinking about contributing to this project. 😍

Adding keywords

  • Make sure the new word is not already part of the keyword array. For example: in "hocho": ["cut", "cutlery"], cut is part of cutlery, so by adding cutlery, you should remove cut from the keyword array.

  • Make sure that the format matches all other lines. The rules are the following:

    • Double quote the words:
      'a'
      "a"

    • A space following comma and colon:
      "horse":["animal","unicorn"],
      "horse": ["animal", "unicorn"],

Committing, sending the pull request

  • It's preferred that when adding a keyword to one specific emoji, you use that emoji or a relevant emoji as the commit message. For example: 2a34a84

  • Make sure you have a good description in the pull request if your changes contain more than keyword changes.
    Update html
    Change a typo in the toggle text button

  • Include at least one emoji in your pull request description.

  • There are tests for emojis.json, please do your best to fix the errors if any. You should be able to see your branch's test status on https://travis-ci.org/muan/emojilib/pull_requests


Publishing

  1. Run npm run build and commit the changes
  2. Update version in bower.json and package.json and commit with changes
  3. git tag [new version number]
  4. git push --tags
  5. npm publish