Skip to content

Commit f53f4b1

Browse files
committed
docs: updated contributing to latest config
1 parent 39112a6 commit f53f4b1

File tree

1 file changed

+12
-47
lines changed

1 file changed

+12
-47
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Developing the SDK Locally
2+
23
*Questions? [Contact us](https://support.branch.io/support/tickets/new)*
34

45
1. [Dependencies](#dependencies)
@@ -25,13 +26,13 @@ export PATH="/usr/local/bin:$PATH";
2526
2627
```sh
2728
brew install node;
28-
```
29+
```
2930

3031
> Gulp
3132
3233
```sh
3334
npm install -g gulp-cli;
34-
```
35+
```
3536

3637
### SDK
3738

@@ -46,12 +47,8 @@ npm install --save-dev;
4647

4748
### Develop
4849

49-
> Build
50+
> Changes to `/src` don't need a `init.sh` rebuild, just a `cordova run ios`
5051
51-
```sh
52-
gulp prerelease;
53-
```
54-
5552
> **[optional]** Update [Android](https://github.com/BranchMetrics/android-branch-deep-linking/releases) and [iOS](https://github.com/BranchMetrics/ios-branch-deep-linking/releases) SDKs
5653
5754
```sh
@@ -60,58 +57,26 @@ gulp prerelease;
6057

6158
### Test
6259

63-
> Modify `BRANCH_KEY` and `URI_SCHEME` and `config.xml` to values in [Branch Dashboard](https://dashboard.branch.io/settings/link)
64-
65-
```sh
66-
gulp prerelease; cd testbed; npm install -g cordova; cordova platform remove ios; cordova platform remove android; cordova platform remove browser; cordova platform add ios; cordova platform add android; cordova plugin remove branch-cordova-sdk; cordova plugin add ../ --variable BRANCH_KEY=key_live_icCccJIpd7GlYY5oOmoEtpafuDiuyXhT --variable URI_SCHEME=enefftest;
67-
68-
gulp prod;
69-
cd testbed;
70-
npm uninstall mkpath node-version-compare plist xml2js;
71-
rm -rf ../.installed;
72-
rm -rf ./plugins;
73-
rm -rf ./platforms;
74-
cordova platform add ios;
75-
cordova plugin add ../;
76-
cordova build ios --developmentTeam="PW4Q8885U7";
77-
open -a Xcode platforms/ios/Branch\ Testing.xcworkspace;
78-
79-
```
80-
8160
> Validate all features on both `iOS` and `Android` on `device` only (no `simulator` or `TestFlight`)
8261
62+
> ios
63+
8364
```sh
84-
cordova build ios --developmentTeam="PW4Q8885U7"; open -a Xcode platforms/ios/Branch\ Testing.xcworkspace;
65+
./testbed/init -idc
8566
```
67+
68+
> android
8669
8770
```sh
88-
cordova build android; cordova run android;
89-
chrome://inspect/#devices
71+
./testbed/init -adc
9072
```
9173

92-
> Test harnesses `TODO`
93-
9474
### Submit
9575

96-
> **Required** [Semantic Release](https://github.com/semantic-release/semantic-release) comments `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`
76+
> **Required** [Semantic Release](https://github.com/semantic-release/semantic-release) comments `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`. Versioning handled automatically based on commit messages.
9777
9878
> Submit code with a [pull request](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking)
99-
100-
```sh
101-
git checkout -b BRANCH_NAME;
102-
git add FILE_NAME;
103-
npm run commit;
104-
git push origin BRANCH_NAME;
105-
```
10679
10780
### Publish
10881

109-
> Update `CHANGELOG.md`
110-
> Update version within plugin.template.xml
111-
> Run `gulp prerelease`
112-
> Merge Pull Request - code to NPM will happen automatically
113-
114-
115-
## Hooks
116-
117-
Don't need to `rebuild.sh`, just re-run `cordova build ios`
82+
> Code review from a Branch member. Merge will automatically add SDK to NPM.

0 commit comments

Comments
 (0)