Thank you for either opening a pull request or an issue. I makes me feel like people like using my creations and care enough to give back! π
There are three ways you can contribute:
- emoji proposals
- raise issues
- architectural suggestions
For the best chance of your contribution making into the next release, please follow these steps for pull requests and issues respectively.
- add your proposals in one of the existing
.md
reference files insidereferences/
folder - run build task (cmd+shift+B) or
$ python3 -m translate
to generate json theme files - start debug (F5) to preview your changes
β οΈ Do not commit any*icon-theme.json
files, these will be generated in the CI/CD workflow
β οΈ For compatibility purposes, please try to use emojis release in 2020 or earlier. You may check your emojis here
In references/*.md
files, each proposal has to follow the following format rules exactly.
- start the line with a
-
, all other lines are considered comments - one emoji per line
- iconId can use the or operator
|
(one space each side) - extensions should start with
.
- anything in brackets after iconId are considered comments
examples:
yes
- π option1.md | option2.txt
- β€οΈ .extension (optional comment)
no
- 1οΈβ£2οΈβ£ filename (two emojis one line)
- π noLeftSpace.ts|noRightSpace.js
- π (comment out of place) .extension
Screenshots are much appriciated but not required.