Skip to content

Commit

Permalink
Add new process documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
shaunsaker committed May 31, 2018
1 parent fdf7512 commit b7172a0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ A react-native, redux, redux-saga and firebase project.
* [Style guide](./docs/STYLE_GUIDE.md)
* [Setup guide](./docs/SETUP_GUIDE.md)
* [VSCode snippets](./snippets.json) for sagas, stylesheet, component index, dumb, functional and container components (makes life _waaay_ easier)
* [Process](./docs/PROCESS.md)
* [Tools](./docs/TOOLS.md)
* [Troubleshooting](./docs/TROUBLESHOOTING.md)

Feel free to [get in touch](mailto:shaun@aux.co.za) if you have questions or suggestions :)

# TODOS

* Add process documentation
* Add license to docs
* Add iPhoneX helper to styleConstants
* Get set for transfer to AUX
Expand Down
19 changes: 19 additions & 0 deletions docs/PROCESS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Process

We work off of the `develop` branch and use a pull request work flow. Whenever you have some work to do:

```shell
git checkout develop
git pull
git checkout -b "YOUR_NAME-FEATURE_NAME"
```

Do some work.

```shell
git push -u origin YOUR_BRANCH_NAME
```

When you're done, create a pull request on github using the following [template](https://embeddedartistry.com/blog/2017/8/4/a-github-pull-request-template-for-your-projects).

This workflow is quite new, so if you have any suggestions on how it can be improved, [shout](mailto:shaun@aux.co.za)!

0 comments on commit b7172a0

Please sign in to comment.