docs: Improve documentation for contributing.
Hadrien Froger hadrien@octree.ch
Thu, 05 Jun 2025 15:14:05 +0000
2 files changed,
59 insertions(+),
18 deletions(-)
M
CONTRIBUTING.md
→
CONTRIBUTING.md
@@ -1,40 +1,78 @@
## How to contribute to Caroster +Caroster is an open-source project maintained by the [Caroster Team](https://fr.glassfrog.com/organizations/14555/orgnav/roles/13689524/overview). +We appreciate your interest in contributing to Caroster! -#### **Did you find a bug?** +All work is done on our [Gitlab](https://git.octree.ch/p/caroster) and mirrored to Github. -- **Do not open up an issue if the bug is a security vulnerability**, and instead to send an email to caroster@octree.ch. +There is many way you can contribute to Caroster, as Caroster is a volunteer effort: -- **Ensure the bug was not already reported** by searching on GitLab under [Issues](https://git.octree.ch/p/caroster/-/issues). +#### **Test Caroster** +Testing the functionnalities are highly important for us. To test the last stable version, you can go on [caroster.io](https://caroster.io). +If you want to test the last unstable version and have the skills to run a Caroster locally, you are also more than welcome. -- If you're unable to find an open issue addressing the problem, [open a new one](https://git.octree.ch/p/caroster/-/issues/new). 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. +To [open a new one](https://git.octree.ch/p/caroster/-/issues/new) please mind to share: +- What did you do before the issue happens? +- With what device (browser, OS, mobile)? +- What did you expect? +- What did happen ? + +Screenshots, URLs are also more than welcome. Code samples and executable test cases are the bests. -#### **Did you write a patch that fixes a bug?** +Please mind: +1. **Do not open up an issue if the bug is a security vulnerability**, and instead to send an email to caroster@octree.ch. +2. **Ensure the issue was not already reported** by searching on GitLab under [Issues](https://git.octree.ch/p/caroster/-/issues). -- Open a new GitLab merge request with the patch. +#### **Contribute to bug fixes** +- Open a new GitLab merge request with the fix. - Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. +- Add tests that demonstrate the fix. -#### **Do you want to translate Caroster?** +#### **Translate Caroster** - You can follow the detailed process here : [Translating the Caroster app as a contributor ](https://octreegva.notion.site/Translating-the-Caroster-app-as-a-contributor-13612ef1253c8021abb0fcb2512fe8fe) - - Go to [the weblate project](https://translate.codeberg.org/projects/caroster/web-app/). - - Read and accept the contributor agreement. - - Refer to [Weblate documentation](https://docs.weblate.org/en/latest/user/translating.html) to learn how to use Weblate. -- You can also ask us for a [Tolgee access](https://tolgee.io/) 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. +#### **Add or change Features** -- 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](https://tolgee.io/platform/) for that. +- Suggest your proposal in [https://feedback.caroster.io/](https://feedback.caroster.io/) with the following information: + 1. A title and description of your proposal + 2. How this feature or change will impact your use + 3. If you are willing to develop the feature yourself +- Our Caroster Product Owner will review your proposal (and may contact you by email or on the feecdback platform). +- If your proposal has been accepted and you are willing to develop it, someone from the product team will contact you to help! + +### **Propose a change (RFC)** +To propose an architectural change of the code, a change of the contribution process, or any changes that is not related to a specific area of the code, open a RFC! +A Request For Comment is an issue that introduce a discussion you want to have with the community or the Caroster Team. + +A Request For Comment need to have the following information: +- Context: Why do you request comment at the first place? +- Proposal: What would you like to propose? +- Alternatives: What did you think as an alternative +- Expectation: Do you need a decision? Just an open discussion? + +We do not expect RFC's author to stay accountable for the implementation of anything after posting a proposal. +We will though close a RFC if the author stays unresponsive for more than a month. -#### **Do you intend to add a new feature or change an existing one?** +### **Contribute to the documentation** +For now, we do not maintain documentation beyond the README.md. If you have suggestion, please open a RFC. + +### **Support financialy** +Support financially the Caroster Team on [opencollective](https://opencollective.com/caroster#category-CONTRIBUTE) is a great help for us. + +### **Promote Caroster.io** +Follow, share, comment on social media helps us greatly. +- Linkedin: [caroster](https://www.linkedin.com/company/caroster/posts) +- Mastodon (in french): [@caroster](https://piaille.fr/@caroster) -- Suggest your proposal by creating a [new issue](https://git.octree.ch/p/caroster/-/issues/new). +If you plan to talk about caroster in events, please send us an email to spread the news! (caroster@octree.ch) -- 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! :heart:
M
README.md
→
README.md
@@ -162,7 +162,10 @@ ```
## Contributing -Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us. +All contributors and persons involved in the project follow our [code of conduct](CODE_OF_CONDUCT.md). + +*N.B.* Use [our Gitlab](https://git.octree.ch/p/caroster) to submit any PR or issues ## Authors@@ -172,4 +175,4 @@ See also the list of [contributors](https://github.com/octree-gva/caroster/graphs/contributors) who participated in this project.
## License -This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details +This project is licensed under the GNU Affero General Public License v3 - see the [LICENSE.md](LICENSE.md) file for details