diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41e7f20..83934e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,17 +14,17 @@ This repository contains minimal code for native Android and iOS. The implementa ### Local Setup 1. Fork and clone the repo. -1. Install the dependencies. +2. Install the dependencies to use the plugin. - ```shell - npm install - ``` + ```shell + npm install + ``` -1. Install SwiftLint if you're on macOS. +3. Install SwiftLint if you're on macOS. - ```shell - brew install swiftlint - ``` + ```shell + brew install swiftlint + ``` ### Scripts @@ -46,7 +46,7 @@ This is useful to run in CI to verify that the plugin builds for all platforms. Check formatting and code quality, autoformat/autofix if possible. -This template is integrated with ESLint, Prettier, and SwiftLint. Using these tools is completely optional, but the [Capacitor Community](https://github.com/capacitor-community/) strives to have consistent code style and structure for easier cooperation. +The `lint` command is run in CI. We recommend running `lint` and/or `fmt` before opening a PR, ## Commits/PR's @@ -62,6 +62,6 @@ Publishing is automated based on the branch committed to. When a commit or merge | next | next (these are betas/alphas) | next | @capacitor/inappbrowser@1.0.0-next.1 | | main | latest | latest | @capacitor/inappbrowser@1.0.0 | -- In general new developments will go straight to `main`. If we want to have non-stable versions (e.g. for new Capacitor versions or when there are many changes), we may use `next` or `development` branch, and then once they are ready for stable version, open a PR to main (should be rebased to keep history). +- In general new developments will go straight to `main`. If we want to have non-stable versions (e.g. for new Capacitor versions or when there are many changes), we may use `next` or `development` branch, and then once they are ready for stable version, open a PR to main (should be merged to keep commit hashes for `semantic-release`). -> **Note**: The [`files`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#files) array in `package.json` specifies which files get published. If you rename files/directories or add files elsewhere, you may need to update it. +> **Note**: The [`files`](https://docs.npmjs.com/cli/configuring-npm/package-json) array in `package.json` specifies which files get published. If you rename files/directories or add files elsewhere, you may need to update it.