Skip to content

Commit f6a5d27

Browse files
committed
docs(contributing): add local setup and publishing docs
1 parent fc1421e commit f6a5d27

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing
2+
3+
:mega: **Support/Questions?**: Please see our [Support
4+
Page](https://ionicframework.com/support) for general support questions. The
5+
issues on GitHub should be reserved for bug reports and feature requests.
6+
7+
### Local Setup
8+
9+
1. Fork the repo & clone it locally.
10+
1. `npm install`
11+
1. `npm run build` to build source files
12+
13+
#### Warning: `npm link` may not work
14+
15+
Using symlinks for Angular tooling may lead to issues. To test changes in a real project, copy the library to `node_modules/@ionic/angular-toolkit`. For example, using `rsync`:
16+
17+
```
18+
rsync -avuP --exclude .git --exclude node_modules /path/to/git/angular-toolkit node_modules/@ionic
19+
```
20+
21+
### Publishing
22+
23+
CI automatically publishes the next version semantically from analyzing commits in `stable`. To maintain a shared history between `master` and `stable`, the branches must be rebased with each other locally.
24+
25+
* When it's time to cut a release from `master`:
26+
27+
```
28+
git checkout stable
29+
git rebase master
30+
git push origin stable
31+
```
32+
33+
* Await successful publish in CI. Ionitron will push the updated versions and tags to `stable`.
34+
* Sync `master` with `stable`.
35+
36+
```
37+
git pull origin stable
38+
git checkout master
39+
git rebase stable
40+
git push origin master
41+
```

0 commit comments

Comments
 (0)