Skip to content

Commit 1ab8823

Browse files
docs: update Changelog and Contributing guide
1 parent 2e02411 commit 1ab8823

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

CHANGELOG.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@
55

66
* export package.json to fix cap sync issues ([#11](https://github.com/ionic-team/capacitor-file-viewer/issues/11)) ([bb9b222](https://github.com/ionic-team/capacitor-file-viewer/commit/bb9b2221abaaa3ea9aee8e81ce913df45146967b))
77

8-
# Change Log
9-
10-
All notable changes to this project will be documented in this file.
11-
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
12-
138
## [1.0.3](https://github.com/ionic-team/capacitor-file-viewer/compare/v1.0.2...v1.0.3) (2025-08-20)
149

1510

CONTRIBUTING.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,12 @@ This repository contains minimal code for native Android and iOS. The implementa
1313

1414
### Local Setup
1515

16-
1. Fork and clone the repo, uncheking the clone `main` branch only option.
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.
16+
1. Fork and clone the repo.
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

2023
```shell
2124
npm install
@@ -55,17 +58,15 @@ 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

6063
| Branch Name | Build Type | NPM Tag | Example NPM Version |
6164
| ----------- | ----------------------------- | ------- | ---------------------------------- |
6265
| development | dev | dev | @capacitor/file-viewer@1.0.0-dev.1 |
6366
| next | next (these are betas/alphas) | next | @capacitor/file-viewer@1.0.0-next.1 |
6467
| main | latest | latest | @capacitor/file-viewer@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

7171
> **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.
72+

0 commit comments

Comments
 (0)