Skip to content

Commit 6ef910a

Browse files
docs: minor contributing guide improvements (#77)
1 parent 2fa6e16 commit 6ef910a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ Then, Rollup will bundle the code into a single file at `dist/plugin.js`. This f
4040

4141
Build and validate the web and native projects.
4242

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

4545
#### `npm run lint` / `npm run fmt`
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/filesystem@7.1.0-next.1 |
6363
| main | latest | latest | @capacitor/filesystem@7.1.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)