Skip to content

Latest commit

 

History

History
41 lines (21 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

41 lines (21 loc) · 2.42 KB
Raw

How to contribute to Caroster

Did you find a bug?

  • Do not open up an issue if the bug is a security vulnerability, and instead to send an email to caroster@octree.ch.

  • Ensure the bug was not already reported by searching on GitLab under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitLab merge request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you want to translate Caroster?

  • You can follow the detailed process here : Translating the Caroster app as a contributor

  • Go to the weblate project.

  • Read and accept the contributor agreement.

  • Refer to Weblate documentation to learn how to use Weblate.

  • You can also ask us for a Tolgee access which enables in context translation of the frontend app. Be aware we are not yet able to credit contributions made trough Tolgee which is entended for internal use at the moment.

  • In the other hand, you can setup your own development instance with your own Tolgee Project by simply importing locales files with the namespace "translation", the application supports Tolgee configuration using NEXT_PUBLIC_TOLGEE_API_KEY and NEXT_PUBLIC_TOLGEE_API_URL env variables located in the frontend folder. This way you can contribute to translations on your computer and commit the updated locales files. See Tolgee documentation for that.

Do you intend to add a new feature or change an existing one?

  • Suggest your proposal by creating a new issue.

  • When your proposal has been accepted by a maintainer, write your code then create a Pull Request linked to your issue.

Caroster is a volunteer effort.

Thanks! ❤️

Caroster Team