Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (26 loc) · 816 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 816 Bytes
Raw

Contributing

This guide provides instructions for contributing to the Capgo privacy screen plugin.

Developing

Local Setup

  1. Fork and clone the repo.
  2. Install dependencies.
bun install
  1. Install SwiftLint if you're on macOS.
brew install swiftlint

Scripts

bun run build

Builds plugin web assets and generates API documentation with @capacitor/docgen.

bun run verify

Builds and validates iOS, Android, and Web.

bun run lint / bun run fmt

Checks or auto-fixes formatting and linting.

Publishing

The prepublishOnly hook prepares the plugin before publishing.

bun publish

The files array in package.json controls what is published. Update it if you move files.