Skip to content
Playlist Pipeline

Contributing

Playlist Pipeline is open source and we welcome contributions!

Ways to Contribute

Section titled “Ways to Contribute”
  • Report bugs - Found a bug? Open an issue on GitHub
  • Suggest features - Have an idea? Start a discussion
  • Improve docs - See a typo or unclear explanation? Submit a PR
  • Write code - Fix bugs or implement features

Development Setup

Section titled “Development Setup”
  1. Fork the repository
  2. Clone your fork
  3. Install dependencies:
Terminal window
bun install
  1. Start the development database:
Terminal window
bun run dev:db:start
  1. Run the app you want to work on:
Terminal window
bun run dev:api
bun run dev:web

Pull Requests

Section titled “Pull Requests”
  1. Create a branch for your changes
  2. Make your changes
  3. Run tests and linting:
Terminal window
bun verify
  1. Submit a pull request

Code Style

Section titled “Code Style”
  • We use Biome for formatting and linting
  • Run bun fmt to format your code
  • Follow existing patterns in the codebase

Questions?

Section titled “Questions?”

If you’re unsure about something, open a discussion on GitHub before starting work. We’re happy to help!