Skip to content
Snippets Groups Projects
guidelines.md 6.27 KiB
title: Guidelines

Contributing to Castopod

Love Castopod and want to help? Thanks so much, there's something to do for everybody!

::: tip Note

Castopod follows the all contributors specification in an effort to recognize any kind of contribution, not just code!

If you've made a contribution and do not appear in the contributors list, please let us know so we can correct our mistake! :slight_smile:

:::

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Translating Castopod

We use Crowdin to manage translation files for Castopod, the documentation and the landing websites.

Whether you'd like to correct a translation error, validate new translations or include your language to Castopod, head into the crowdin project to get started.

::: info Note

To prevent degrading user experience, new languages are included to Castopod when they reach a certain threshold (~90%).

// TODO: ease acceptance criteria (to public pages?)

:::

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

:warning: Security issues and vulnerabilities

If you encounter any security issue or vulnerability in the Castopod source, please contact us directly by email at security@castopod.org