✍️ Contributing

Contributions are welcome! Here's how you can help:

📚 Translations

Visit our Weblate page
Login / Register
Start translating!
- If you are adding a translation which language or territory specific version doesn't exist yet click on Start new translation
- If there already is a translation for your language, and you want to correct a string just click on the language and make your change

Fork the frontend or website and clone your fork.
Start translating!
- Add a translation file in /src/locales/
- If you are adding a translation which language doesn't exist yet, name your translation [COUNTRY_CODE].json
- If there already is a translation for your language, and you want to add a territory specific one, name your translation [COUNTRY_CODE]-[TERRITORY].json so that it plays nicely with the Implicit fallback
- Replace [COUNTRY_CODE] with your corresponding code. See the list here (Use column 639-1)
- Replace [TERRITORY] with your corresponding territory code. See the list here (Use column Alpha-2 code)
- Add the corresponding translations for your language
Commit your changes to a new branch (not master, one change per branch) and push it:
- Use Semantic Commit Messages
Once you are happy with your translation, submit a pull request.

Before you start contributing please make sure to do the following things:

Check if a branch exists, that already contains the changes you want to work on
Please may also contact us ^{_{(We'll reply as fast as we can!)}} before you start working on something because we may already work on the same thing but just haven't pushed any of those changes yet

Fork the repository and clone your fork.
Start coding!
- Implement your feature.
- Check your code works as expected.
- Run the code formatter: clang-format -i $(git ls-files "*.cpp" "*.hpp")
Commit your changes to a new branch (not master, one change per branch) and push it:
- Use Semantic Commit Messages
Once you are happy with your changes, submit a pull request.
- Open the pull request.
- Add a short description explaining briefly what you've done (or if it's a work-in-progress - what you need to do)

Do a quick search in the existing issues to check if the issue has already been reported.
Open an issue and fill in the template

After reporting, you should try to answer any questions or clarifications, as this will help determine the cause of the issue.

We are on Ko-fi