Skip to content

Commit 7ad78a8

Browse files
docs: minor contributing guide improvements
1 parent d548297 commit 7ad78a8

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

plugin/CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ This guide provides instructions for contributing to this Capacitor plugin.
77
### Local Setup
88

99
1. Fork and clone the repo.
10-
1. Install the dependencies.
10+
2. Install the dependencies to use the plugin.
1111

12-
```shell
13-
npm install
14-
```
12+
```shell
13+
npm install
14+
```
1515

16-
1. Install SwiftLint if you're on macOS.
16+
3. Install SwiftLint if you're on macOS.
1717

18-
```shell
19-
brew install swiftlint
20-
```
18+
```shell
19+
brew install swiftlint
20+
```
2121

2222
### Scripts
2323

@@ -33,13 +33,13 @@ Then, Rollup will bundle the code into a single file at `dist/plugin.js`. This f
3333

3434
Build and validate the web and native projects.
3535

36-
This is useful to run in CI to verify that the plugin builds for all platforms.
36+
This is run in CI to verify that the plugin builds for all platforms.
3737

3838
#### `npm run lint` / `npm run fmt`
3939

4040
Check formatting and code quality, autoformat/autofix if possible.
4141

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

4444
## Publishing
4545

0 commit comments

Comments
 (0)