Documentation
Contribute

Contribute

Report issues, work on the roadmap, and improve the code or this documentation.

Podcast Publisher is developed on Drupal.org's GitLab. Contributions are credited on your Drupal.org profile.

Report a problem or idea

Search the issue queue first, then open an issue with a Drupal.org account. For a bug, include your Drupal and module versions, the steps to reproduce, and what you expected. For a feed problem, include the feed URL or the relevant feed output.

Work on the roadmap

The roadmap issue lists the work planned for a stable 1.0.0, from Drupal 12 support to transcripts, chapters, and a web player. Each item links to its own issue.

  1. Comment on the issue that you are working on it.
  2. Create an issue fork and branch from the issue page, using the Manage forks, branches, merge requests, and access link in the issue tools.
  3. Push your changes and open a merge request against 1.0.x.
  4. Mark the issue as ready for review with the state::needsReview label. Without maintainer rights, post the comment /do:label ~state::needsReview.

Every merge request runs Drupal.org's GitLab CI: PHPUnit, PHPStan, PHP_CodeSniffer, cspell, ESLint, and stylelint.

Run the tests locally

The tests are PHPUnit functional tests in tests/src/Functional. With a DDEV Drupal project:

ddev composer require --dev drupal/core-dev
ddev exec 'SIMPLETEST_DB=mysql://db:db@db/db SIMPLETEST_BASE_URL=http://web vendor/bin/phpunit -c web/core web/modules/contrib/podcast_publisher/tests/src/Functional'

To run a single test class, end the command with its file, for example PodcastPublisherFeedTest.php.

Improve this documentation

This site is a Docus project in the podcastpublisher.org repository on GitHub. Pages are Markdown files in content/. Open a pull request, or suggest a change in the issue queue with the documentation label.

yarn install
yarn dev