|
|
# Developer Workflow
|
|
|
# Git
|
|
|
We use git in order to manage our project. Git is well suited to projects based on text based revisions and not binary files so binary blobs should not be included if possible.
|
|
|
## Git workflow
|
|
|
1. The master branch should be considered a stable working version of the pipeline.
|
|
|
2. All development should be made on the dev branch.
|
|
|
3. The development branch itself should not be pushed to and instead should be pulled into.
|
|
|
4. Development for features, or style should be made to a new branch based off the development branch then pushed to a branch upstream.
|
|
|
* You may make pull requests to master for bug fixes that your replicate in dev
|
|
|
5. The branch upstream should then be pulled through the web interface using a pull request.
|
|
|
* You should squash your commits into one commit
|
|
|
6. Once thoroughly tested the development branch should be pulled into the master.
|
|
|
## For example
|
|
|
1. `git checkout dev`
|
|
|
2. `git checkout -b <your name>-<your feature name>`
|
|
|
3. Do development here.
|
|
|
4. `git push origin <your branch name>`
|
|
|
5. From the web interface submit a pull request to the development branch |