Skip to content

Commit be26fa8

Browse files
docs: minor contributing guide improvements (#111)
1 parent 22e87f9 commit be26fa8

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ This repository contains minimal code for native Android and iOS. The implementa
1414
### Local Setup
1515

1616
1. Fork and clone the repo.
17-
1. Install the dependencies.
17+
2. Install the dependencies to use the plugin.
1818

19-
```shell
20-
npm install
21-
```
19+
```shell
20+
npm install
21+
```
2222

23-
1. Install SwiftLint if you're on macOS.
23+
3. Install SwiftLint if you're on macOS.
2424

25-
```shell
26-
brew install swiftlint
27-
```
25+
```shell
26+
brew install swiftlint
27+
```
2828

2929
### Scripts
3030

@@ -46,7 +46,7 @@ This is useful to run in CI to verify that the plugin builds for all platforms.
4646

4747
Check formatting and code quality, autoformat/autofix if possible.
4848

49-
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.
49+
The `lint` command is run in CI. We recommend running `lint` and/or `fmt` before opening a PR,
5050

5151
## Commits/PR's
5252

@@ -62,6 +62,6 @@ Publishing is automated based on the branch committed to. When a commit or merge
6262
| next | next (these are betas/alphas) | next | @capacitor/inappbrowser@1.0.0-next.1 |
6363
| main | latest | latest | @capacitor/inappbrowser@1.0.0 |
6464

65-
- 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).
65+
- 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`).
6666

67-
> **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.
67+
> **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.

0 commit comments

Comments
 (0)