Skip to content

Commit

Permalink
docs: add localisation badge
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Jan 31, 2023
1 parent 77fd3bc commit 62eed52
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

We love your input! 🚀 We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug.
- Discussing the current state of the code.
- Submitting a fix.
- Proposing new features.
- [Reporting a bug](https://github.com/rickstaa/github-emoji-picker/issues).
- [Discussing the current state of the code](https://github.com/rickstaa/github-emoji-picker/discussions).
- [Submitting a fix](https://github.com/rickstaa/github-emoji-picker/pulls).
- [Proposing new features](https://github.com/rickstaa/github-emoji-picker/issues).
- Becoming a maintainer.
- [Providing translations](https://crowdin.com/project/github-emoji-picker/).

## We Develop with Github

Expand Down Expand Up @@ -52,6 +53,10 @@ People _love_ thorough bug reports. I'm not even kidding.

We use [prettier](https://prettier.io/) formatter to format our typescript code. The easiest way to use [prettier](https://prettier.io/) is through the [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) VS Code extensions. You are also advised to use [eslint](https://eslint.org/) for linting your code before.

## Provide translations

The local App translations (i.e. header and footer) are provided through [Crowdin](https://crowdin.com/project/github-emoji-picker). Please check out https://crowdin.com/project/github-emoji-picker if you want to add a card translation. The Emoji-Picker translations are handled by the [Emoji Mart package](https://github.com/missive/emoji-mart). If you want to translate parts of the picker, please open an issue at https://github.com/missive/emoji-mart/issues.

## License

By contributing, you agree that your contributions will be licensed under its MIT License.
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
<a href="https://github.com/rickstaa/github-emoji-picker/actions/workflows/update_emojis.yml">
<img alt="emoji-update-action status" src="https://github.com/rickstaa/github-emoji-picker/actions/workflows/update_emojis.yml/badge.svg">
</a>
<a title="Crowdin" target="_blank" href="https://crowdin.com/project/github-emoji-picker">
<img src="https://badges.crowdin.net/github-emoji-picker/localized.svg">
</a>
</p>

# github-emoji-picker
Expand Down

0 comments on commit 62eed52

Please sign in to comment.