Skip to content
Snippets Groups Projects
Select Git revision
  • develop default protected
  • main protected
  • next protected
  • i18n
  • feat/plugins
  • draft/rss-feed
  • feat/generator-user-agent
  • docs/fix-readme
  • refactor/transcripts
  • fix/forms-ux
  • feat/episodes-page-ux
  • feat/new-languages
  • feat/headliner
  • fix/federation
  • beta protected
  • docs/update-vitepress
  • feat/dashboard
  • alpha protected
  • v1.13.4
  • v1.13.3
  • v2.0.0-next.3
  • v1.13.2
  • v1.13.1
  • v1.13.0
  • v1.12.11
  • v1.12.10
  • v1.12.9
  • v1.12.8
  • v1.12.7
  • v1.12.6
  • v1.12.5
  • v1.12.4
  • v2.0.0-next.2
  • v1.12.3
  • v1.12.2
  • v1.12.1
  • v1.12.0
  • v2.0.0-next.1
38 results
Blame Permalink
guidelines.md 5.46 KiB 
title: Guidelines

Contributing to Castopod

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

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.

::: info Note

Any contribution made on a repository other than the original repository will not be accepted.

:::

Using the issue tracker

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

⚠️ 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

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest main branch in the repository.

  3. Isolate the problem — ideally create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Issue templates have been created for this project. You may use them to help you follow those guidelines.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.