Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (22 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.24 KB
Raw

Contributing

Use this page as the fast entry point for contributors.

Quick Start

  1. Read Setup and run the project locally.
  2. Follow Coding Style while you code.
  3. If you touch options UI/config behavior, read Options Page.
  4. Check Project Structure if you are unsure where code belongs.
  5. Use Committing before opening a PR.
  6. Use Issue Reporting when filing bugs or feature requests.

Useful Things

  • Run development build: bun run dev or bun run dev:firefox
  • Build release artifacts: bun run build:chrome and bun run build:firefox
  • Package zip files: bun run package:chrome and bun run package:firefox
  • Build release candidate artifacts: bun run rc:chrome and bun run rc:firefox
  • Package the source tree: bun run package:source
  • Validate changes before committing: bun run check
  • Format code before committing: bun run format
  • Formatter is also enforced by pre-commit hooks.
  • Commit messages are also checked by commitlint in the commit-msg hook. See Committing.

Scope Notes

  • Paths ending in / are directories.
  • Keep PRs focused: one change-set, one clear purpose.