After you've reviewed these contribution guidelines, you'll be all set to
contribute to this project.
CONTRIBUTING.md 1.69 KiB
Contributing
This guide provides instructions for contributing to this Capacitor plugin.
Developing
Local Setup
-
Fork and clone the repo.
-
Install the dependencies.
npm install -
Install SwiftLint if you're on macOS.
brew install swiftlint
Scripts
npm run build
Build the plugin web assets and generate plugin API documentation using @capacitor/docgen.
It will compile the TypeScript code from src/ into ESM JavaScript in dist/esm/. These files are used in apps with bundlers when your plugin is imported.
Then, Rollup will bundle the code into a single file at dist/plugin.js. This file is used in apps without bundlers by including it as a script in index.html.