Contributing

Thanks for your interest in contributing to Better Webhook.

Prerequisites

• Install devbox to manage tools and dependencies.

Getting started

1. Fork and clone the repository.

2. Install dependencies:

   devbox run -- pnpm install --frozen-lockfile

3. Run checks before opening a pull request:

   devbox run -- pnpm run format:check
   devbox run -- pnpm run lint
   devbox run -- pnpm run check-types
   devbox run -- pnpm run test 
   devbox run -- pnpm run build

4. Run the security scan for the changes you added:

   devbox run -- just security-scan

Development guidelines

• Keep changes focused and small when possible.
• Add tests for behavioral or security-sensitive changes.
• Update docs when user-facing behavior changes.
• Follow existing package and workflow conventions.

Pull requests

• Use a clear title that explains intent.
• Include a concise summary and test plan.
• Link related issues when applicable.

Security reports

Do not disclose security vulnerabilities publicly. Report them through the security policy in SECURITY.md.