Contributing

We welcome contributions to Pulsarr! This section outlines the process for contributing to the project.

Fork and Branch Naming

Fork the Repository: Start by forking the Pulsarr repository to your GitHub account.
Branch Naming Conventions:
- For new features: features/your-feature-name
- For bug fixes: bug-fix/brief-bug-description
- For documentation: docs/what-you-are-documenting
- For performance improvements: perf/what-you-are-improving

Create a Branch: Create a new branch following the naming conventions above.
Make Your Changes: Implement your feature or fix the bug.
Write Tests: If applicable, write tests for your changes.
Ensure Code Quality:
- Run linting tools (npm run fix to run biome)
- Ensure tests pass (these are coming!)
- Follow the existing code style
Commit Your Changes: Use clear, descriptive commit messages.
Push to Your Fork: Push your changes to your forked repository.
Submit a Pull Request: Create a pull request from your branch to the develop branch of the main Pulsarr repository.

When adding or modifying API endpoints:

Update Schemas: Ensure all request/response schemas are properly defined using Zod
Add OpenAPI Tags: Include appropriate tags and descriptions in your route definitions

The OpenAPI documentation will be automatically generated during the CI build process, so no manual generation is required.

When submitting a pull request, please:

Describe Your Changes: Provide a clear description of what the changes accomplish.
Link Related Issues: If your PR addresses an open issue, reference it using the GitHub issue linking syntax (e.g., "Fixes #123").
Include Screenshots: If your changes include visual elements, add screenshots to help reviewers understand the context.
Update Documentation: Ensure that documentation is updated to reflect your changes if necessary.
Be Responsive: Be prepared to address feedback and make requested changes.

If you have any questions about contributing, feel free to open an issue with the label "question".