Files
bracket/docs/content/community/contributing.mdx
Erik Vroon 406c926d5e Link to README for contributers (#1225)
I would prefer to keep it here as well, but the GH action doesn't
support mdx files so this section has been broken
2025-05-13 00:03:09 +02:00

58 lines
1.9 KiB
Plaintext

---
title: Contributing
---
# Contributing
If you're using Bracket and would like to help support its development, that would be greatly
appreciated!
Several areas that we need a bit of help with at the moment are:
- ⭐ **Star Bracket** on GitHub
- 🌐 **Translating**: Help make Bracket available to non-native English speakers by adding your
language. See [Translating](#translating) below.
- 📣 **Spread the word** by sharing Bracket to help new users discover it
- 🖥️ **Submit a PR** to add a new feature, fix a bug, extend/update the docs or something else
## Translating
### Adding translations (via crowdin)
Bracket uses [crowdin](https://crowdin.com/project/bracket) for translations. You can add/improve
translations here in your language.
If you want to add a new language, please create an issue and I will add the language to Crowdin.
### Manually adding translations
You can add a translation by copying the English `en` locale
([here](https://github.com/evroon/bracket/tree/master/frontend/public/locales)) directory.
Rename the directory to the name of your locale, and start translating the `common.json` file inside
the directory. It might be useful to use an online tool (Google `translate json file`) to do the
translation for you, and then carefully check and correct any mistakes.
## Contributors
See [README](https://github.com/evroon/bracket).
## Star History
<a href="https://star-history.com/#evroon/bracket&Date">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcSet="https://api.star-history.com/svg?repos=evroon/bracket&type=Date&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcSet="https://api.star-history.com/svg?repos=evroon/bracket&type=Date"
/>
<img
alt="Star History Chart"
src="https://api.star-history.com/svg?repos=evroon/bracket&type=Date"
/>
</picture>
</a>
{/*<!-- markdownlint-enable line-length -->*/}