Interested in contributing? Yay! Here are a few infos how the workflow typically works:
Simply send us the source .svg file and the meta informations via email e.g.:
emoji,hexcode,openmoji_tags,openmoji_author
ℹ️,2139,"advice, info",Jose Avila
You can find the email address at openmoji.org/about. Thanks 🙏!
If you have an original idea about a new emoji or you spot one which is currently missing in Unicode, open an issue describing your emoji, like #84, and let us know you are interested! Initiate a discussion, wait for the green light, and then assign it to yourself!
If steps 3 onwards sound daunting to you, don't worry! You can simply create an issue and attach your SVG files in a .ZIP, see #138 for this process
Before you start working on an .svg design, you should find and name it with the corresponding hexcode. You can find this by searching for the character online and it should look something like 1F389 (🎉) or 1F3C3-200D-2642-FE0F (🏃♂️). If it is not currently an emoji, see the steps in Non-standard emoji
In order to merge you emoji as seamless as possible into the OpenMoji collection, please place the design in the directory like so:
- src/{group}/{subgroups}/{hexcode}.svg
e.g. 🐌
- src/animals-nature/animal-bug/1F40C.svg
🙏 Please follow the OpenMoji Styleguide
Before you submit we ask you to normalize the formatting of the source code of your svg file(s). We want to be agnostic in terms of the editor used to produce the emojis. Every svg editor e.g. Adobe Illustrator, Sketch App, Inkscape etc. produce slightly different formated svg files on export. More information about how to export files can be found in our styleguide. As we want to have a consistent svg source code style, hence please run the command below to normalize all your files or an individual file.
Normalize all files in src folder (⚠ this might take some time):
npm run pretty-src-svgNormalize an individual file e.g.:
node_modules/.bin/svgo src/activities/arts-crafts/1F3A8.svg --config helpers/beautify-svg.ymlTo ensure that all of our designs are consistent, please use the OpenMoji Tester App to check whether your emoji passes our automated tests. All of your svg files have to produce green tests only ✅, fix your files until everything is green! Please! :)
Add your meta infos at the very end to exacltly one of the following files:
data/enhancements-emoji-unicode-data.csvif you have designed a standard Emoji which is part of Unicodedata/extras-openmoji.csvif you have designed a non-standard Emoji which is not part of Unicode and should go into Private Use Area, see →
Non-standard emojidata/extras-unicode.csvif you have designed a standard Unicode character but which is also not part of the Unicode Emoji standard, see → Non-standard emoji
N.B. the properties prefixed openmoji_ are not part of the Unicode specification.
Run npm run generate-data-tables to generate from the .csv files above the deduced OpenMoji data tables. This is important as the automated unit test and other mechanisms rely on the central data file data/openmoji.json
Yay! Now all your files are ready to go! Please submit a PR against the master branch. Please submit only the files in src folder, and do not generate the files in color and black folders. We will take care of your OpenMoji from there! Thanks 🙏!
Fork the OpenMoji repository and create a "PR" pull request from your fork. (Here is also a friendly video tutorial on "PR" pull requests by Daniel Shifmann / The Coding Train)
There are two options for adding extra emoji. If the symbol exists as a Unicode code point already - like math symbols, heiroglyphics - you can design and add it to src/extras-unicode. If the symbol does not exist, it can be added instead as an OpenMoji symbol in src/extras-openmoji.
In either case, please check that the emoji follows our Contribution Guidelines for Non-Unicode.
As an example, many of the designs in the Miscellaneous Symbols section are perfect for emojis. Please create a folder under src/extras-unicode with the "sub-group" name. Name the svg as the unicode codepoint in this folder, e.g. ⬌ (25A1), and add the information about the file to data/extras-unicode.csv
Emojis that are not (yet) defined in Unicode are located in the Private Use Area. The Hexcode runs from E000 to F8FF. The total number of code points is 6.400.
For the OpenMoji project we divided the private use are into 100 equal sized blocks of 64 code points:
| subcategory | block start | block end |
|---|---|---|
| animals-nature | E000 | E040 |
| brand | E040 | E080 |
| emergency | E080 | E0C0 |
| … | … | … |
If a subgroup needs more than 64 code points, then the subgroup continues in the next free block. An overview gives this Google Doc. The names of subgroups (in extras-openmoji) are a close as possible aligned with already defined Unicode Emoji ones.
Next add the information about the new character to data/extras-openmoji.csv. Finally run npm run generate-data-tables and then create a Pull Request.
If it's not on the issues list, add it. If it's already on the issues list, assign it to yourself or comment on the issue indicating you're working on it. Go ahead and fix it and submit a PR.
- Install node.js (see version in the file
.nvmrc) - Open Terminal and navigate over to the
openmojifolder that you downloaded onto your computer:
cd path/to/folder- Run:
npm installIf you want to run the bash scripts (.sh files) in the helpers folder e.g. for exporting png files, you will have to install additional dependencies.
The folder test/ contains automated unit tests to ensure consistency across all source .svg and production files. You can run all tests with:
npm testall tests including checking production filesnpm run test-devall tests excluding checking production files
Or run individual test e.g. all "xxx layer existing" tests:
node_modules/.bin/mocha --grep "layer existing" test/*.js --openmoji-data-json $PWD/data/openmoji.json --openmoji-src-folder $PWD/src