Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (33 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.15 KB

Contributing to better-webhook

Thanks for your interest in contributing.

Getting started

Prerequisites: Install devbox. This repo uses devbox to manage tools and dependencies.

  1. Fork and clone the repository.

  2. Install dependencies:

    devbox run -- pnpm install --frozen-lockfile

  3. Build and run tests 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 build

  4. Run 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.