Skip to content

Latest commit

聽

History

History
47 lines (26 loc) 路 3.59 KB

CONTRIBUTING.md

File metadata and controls

47 lines (26 loc) 路 3.59 KB
Raw

How to Contribute

First off, thank you for contributing! We're excited to collaborate with you! 馃帀

The following is a set of guidelines for the many ways you can join our collective effort.

Before anything else, please take a moment to read our Code of Conduct. We expect all participants, from full-timers to occasional tinkerers, to uphold it.

Reporting Bugs, Asking Questions, and Suggesting Features

Have a suggestion or feedback? Please go to Discussions and open a new discussion.

For bugs, please head to Issues and open a new issue. Screenshots help us resolve issues and answer questions faster, so thanks for including some if you can.

Translating

We use GlotPress to manage translations. Please go to the Pocket Casts for iOS GlotPress page for more information on how to add or edit translations.

Beta Testing

Interested in using the upcoming versions of Pocket Casts? Do you love giving feedback on new features and don't mind reporting bugs that come up along the way? Join us in the beta-testing program by sending us your email through support@pocketcasts.com.

Submitting Code Changes

If you're just getting started and want to familiarize yourself with the app鈥檚 code, we suggest looking at these issues with the good first issue label. But if you鈥檇 like to tackle something different, you're more than welcome to visit the Issues page and pick an item that interests you.

We always try to avoid duplicating efforts, so if you decide to work on an issue, leave a comment to state your intent. If you choose to focus on a new feature or the change you鈥檙e proposing is significant, we recommend waiting for a response before proceeding. The issue may no longer align with project goals.

If the change is trivial, feel free to send a pull request without notifying us.

Pull Requests and Code Reviews

All code contributions pass through pull requests. If you haven't created a pull request before, we recommend this free video series, How to Contribute to an Open Source Project on GitHub.

The core team monitors and reviews all pull requests. Depending on the changes, we will either approve them or close them with an explanation. We might also work with you to improve a pull request before approval.

We do our best to respond quickly to all pull requests. If you don't get a response from us after a week, feel free to reach out to us via Slack.

Note: If you are part of the org and have the permissions on the repo, don't forget to assign yourself to the PR, and add the appropriate GitHub label and Milestone for the PR

PR merge policy

  • PRs require one reviewer to approve the PR before it can be merged to the base branch
  • We keep the PR git history when merging (merge via "merge commit")
  • Who merges the PR once it's approved and green?
    • For PRs authored by people external to the organisation and not having push permissions, the reviewer who approved the PR will merge it.
    • For PRs authored by contributors with push permissions, the author of the PR will merge their own PR.