Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

58 lines (34 loc) · 2.24 KB
Raw

CONTRIBUTING

Thanks for thinking about contributing to this project. 😍

What do you want to do?

Add 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 follwing comma and colon:
      ❌ "horse":["animal","unicorn"],
      ⭕ "horse": ["animal", "unicorn"],

JavaScript changes

The JavaScript is currently compiled from CoffeeScript, so you will need to install and develop in CoffeeScript, then include the compiled JavaScript file in your commits.

CSS changes

The CSS is currently compiled from SCSS, so you will need to install and develop in SASS, then include the compiled CSS file in your commits.

Coding Style

When in doubt, follow https://github.com/styleguide.

Development

To run emoji locally, grab Foreman and run it from the project root:

foreman start

This will do the following:

  • Start sass to compile the stylesheets and watch for changes.
  • Start coffeescript to compile the javascripts and watch for changes.
  • Start WEBrick to serve the site.

Once foreman is running you can visit http://localhost:4001 to view the site.

When you're done, press ctrl + c to stop everything.

Commiting, 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/emoji/pull_requests