Skip to content

Commit c618fff

Browse files
docs: update contributing guide
1 parent 2ae536e commit c618fff

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
This guide provides instructions for contributing to this Capacitor plugin.
44

5+
## Native code
6+
7+
This repository contains minimal code for native Android and iOS. The implementation for native mobile exists in separate repositories:
8+
9+
- [Contributing for Android](https://github.com/OutSystems/OSInAppBrowserLib-Android)
10+
- [For iOS](https://github.com/OutSystems/OSInAppBrowserLib-iOS)
11+
512
## Developing
613

714
### Local Setup
@@ -43,19 +50,18 @@ This template is integrated with ESLint, Prettier, and SwiftLint. Using these to
4350
4451
## Commits/PR's
4552

46-
Commits and PR's should use the `conventional-commits` format so the release process can version and create changelog correctly.
47-
53+
Commits and PR's should use the [conventional-commits](https://www.conventionalcommits.org/) format so the release process can version and create changelog correctly.
4854
4955
## Publishing
5056
51-
Publishing is automated based on the branch committed to. When a commit or merge is made to a branch a release that corresponds with the branch will be created:
57+
Publishing is automated based on the branch committed to. When a commit or merge is made to a branch a release that corresponds with the branch will be created (main requires manual trigger):
5258
53-
| Branch Name | Build Type | NPM Tag | Example NPM Version |
54-
|---|---|---|---|
55-
| dev | dev | dev | @capacitor/[email protected] |
56-
| next | next (these are betas/alphas) | next | @capacitor/[email protected].1-next.1 |
57-
| main | latest | latest | @capacitor/[email protected].2 |
59+
| Branch Name | Build Type | NPM Tag | Example NPM Version |
60+
| ----------- | ----------------------------- | ------- | ---------------------------------- |
61+
| development | dev | dev | @capacitor/[email protected] |
62+
| next | next (these are betas/alphas) | next | @capacitor/[email protected].0-next.1 |
63+
| main | latest | latest | @capacitor/[email protected].0 |
5864
59-
Dev work should be done by creating and merging PR's into the `dev` branch until a feature set is complete enough to then merge the `dev` branch into the `next` branch where it becomes a beta/alpha tagged under `next` for testing teams to use before full release. Upon completed testing the `next` branch is merged into `main` for a full release to be made. The `main` branch should then be merged into `dev` and `next` to keep them up to date with the latest code base.
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).
6066
6167
> **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.

0 commit comments

Comments
 (0)