CONTRIBUTING.md

How to Contribute

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.

Emoji Proposal Pull Requests

1. add your proposals in one of the existing .md reference files inside references/ folder
2. run build task (cmd+shift+B) or $ python3 -m translate to generate json theme files
3. 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

Issues

Screenshots are much appriciated but not required.