73 lines (45 loc) · 1.46 KB

Contributing

Git Branch Workflow

This project adheres to GitHub Flow.

Development (Not for customers)

This code base is written in TypeScript so it cannot be included locally in an application without a build step. Luckily, we have provided one :)

Allow NPM package to be linked
```
npm link
```
Start the watch process for building the code when changes occur
```
npm start
```
In your application, link to this package instead of a version on NPM
```
npm link @oneblink/apps-react
```

Release Process

Checkout master
```
git checkout master
```
Get the latest code
```
git pull
```
Start the release process
```
npm run release
```

Alpha Release Process

This process is only for code in a ticket branch which cannot be merged into master yet, due to an ongoing prior release.
Checkout the branch
```
git checkout <branch>
```
Start the release process
```
npm run release
```
The version should be set to whatever you anticipate the next version will be with -alpha.x appended.

Example

Current version: 3.2.3-beta.2 (when that release is finished it will become 3.2.3)
Depending on the scope of your changes, your first alpha should be: 3.2.4-alpha.1 or 3.3.0-alpha.1
Subsequent alphas should just increment the -alpha.x suffix.