Skip to content

Commit 273271f

Browse files
docs: Update changelog and contributing guide
1 parent af55d85 commit 273271f

File tree

2 files changed

+24
-29
lines changed

2 files changed

+24
-29
lines changed

CHANGELOG.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
1-
# Change Log
2-
3-
All notable changes to this project will be documented in this file.
4-
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5-
6-
# [7.1.5](https://github.com/ionic-team/capacitor-geolocation/compare/v7.1.4...v7.1.5) (2025-08-12)
1+
## [7.1.5](https://github.com/ionic-team/capacitor-geolocation/compare/v7.1.4...v7.1.5) (2025-08-12)
72

83
### Fixes
94

105
- **ios:** fixes an issue where the plugin stops receiving location updates after calling the clearWatch method. ([#38](https://github.com/ionic-team/capacitor-geolocation/pull/38))
116

12-
# [7.1.4](https://github.com/ionic-team/capacitor-geolocation/compare/v7.1.3...7.1.4) (2025-07-15)
7+
## [7.1.4](https://github.com/ionic-team/capacitor-geolocation/compare/v7.1.3...7.1.4) (2025-07-15)
138

149
### Fixes
1510

@@ -20,21 +15,21 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
2015

2116
- **ios** Add note about background usage description ([#29](https://github.com/ionic-team/capacitor-geolocation/pull/29))
2217

23-
# [7.1.3](https://github.com/ionic-team/capacitor-geolocation/compare/7.1.2...v7.1.3) (2025-06-26)
18+
## [7.1.3](https://github.com/ionic-team/capacitor-geolocation/compare/7.1.2...v7.1.3) (2025-06-26)
2419

2520
### Fixes
2621

2722
- **ios:** handle location watch callbacks recovery after backgrounding. More info [here](https://github.com/ionic-team/capacitor-geolocation/issues/19).
2823
- Set dependency on @capacitor/synapse to 1.0.3 to fix ssr environments
2924

30-
# [7.1.2](https://github.com/ionic-team/capacitor-geolocation/compare/7.1.1...7.1.2) (2025-02-21)
25+
## [7.1.2](https://github.com/ionic-team/capacitor-geolocation/compare/7.1.1...7.1.2) (2025-02-21)
3126

3227
### Fixes
3328

3429
- **ios:** watchPosition after an error occurs
3530
- **android** properly parsing number parameters
3631

37-
# [7.1.1](https://github.com/ionic-team/capacitor-geolocation/compare/v7.1.0...7.1.1) (2025-02-21)
32+
## [7.1.1](https://github.com/ionic-team/capacitor-geolocation/compare/v7.1.0...7.1.1) (2025-02-21)
3833

3934
### Fixes
4035

CONTRIBUTING.md

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

1616
1. Fork and clone the repo.
17-
2. If you plan to create a new feature or fix a bug, checkout `development` branch (in general Pull Requests should be open for that branch)
18-
3. Install the dependencies.
17+
2. Go inside the plugin folder
18+
```shell
19+
cd packages/capacitor-plugin
20+
```
21+
3. Install the dependencies to use the plugin.
1922

20-
```shell
21-
npm install
22-
```
23+
```shell
24+
npm install
25+
```
2326

2427
4. Install SwiftLint if you're on macOS.
2528

26-
```shell
27-
brew install swiftlint
28-
```
29+
```shell
30+
brew install swiftlint
31+
```
2932

3033
### Scripts
3134

@@ -55,17 +58,14 @@ Commits and PR's should use the [conventional-commits](https://www.conventionalc
5558

5659
## Publishing
5760

58-
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:
61+
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):
5962

60-
| Branch Name | Build Type | NPM Tag | Example NPM Version |
61-
|---|---|---|---|
62-
| development | dev | dev | @capacitor/geolocation@7.1.0-dev.1 |
63-
| next | next (these are betas/alphas) | next | @capacitor/geolocation@7.1.0-next.1 |
64-
| main | latest | latest | @capacitor/geolocation@7.1.0 |
63+
| Branch Name | Build Type | NPM Tag | Example NPM Version |
64+
| ----------- | ----------------------------- | ------- | ---------------------------------- |
65+
| development | dev | dev | @capacitor/geolocation@1.0.0-dev.1 |
66+
| next | next (these are betas/alphas) | next | @capacitor/geolocation@1.0.0-next.1 |
67+
| main | latest | latest | @capacitor/geolocation@1.0.0 |
6568

66-
- Dev work should be done by creating and merging PR's into the `development` branch until a feature set is complete enough to form a release.
67-
- When a feature set is complete enough to form a release, merge the `development` branch into the `next` branch where it becomes a beta/alpha tagged under `next` for testing teams to use before full release. In case a PR is opened from `development` to `next`, avoid squashing the commits, to keep the history.
68-
- Upon completed testing the `next` branch is merged into `main` for a full release to be made. In case a PR is opened from `next` to `main`, avoid squashing the commits, to keep the history.
69-
- The `main` branch should then be merged into `dev` and `next` to keep them up to date with the latest code base.
69+
- 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).
7070

71-
> **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.
71+
> **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)