| ... | ... | @@ -26,17 +26,20 @@ In Boardcore there is a **main branch**: everything that's here has been tested |
|
|
|
|
|
|
|
To make changes to the software you should use **temporary branches**, such as:
|
|
|
|
|
|
|
|
- `development` branches: are branched off from `main` and exist for a limited amount of time for developing a specific feature (e.g. `somesensor`).
|
|
|
|
- `hotfix` branches: when a bug is found on the `main`, a branch is created to find a fix to that bug. When the problem is solved, the branch will be merged with the `main` branch before being cancelled.
|
|
|
|
- `development (-dev at the end of the name)` branches: are branched off from `main` and exist for a limited amount of time for developing a specific feature (e.g. `somesensor-dev`).
|
|
|
|
- `hotfix (-fix at the end of the name)` branches: when a bug is found on the `main`, a branch is created to find a fix to that bug (e.g. `somefix-fix`).
|
|
|
|
- `update (-upd at the end of the name)` branches: when an update is needed, a branch is created to update the code (e.g. `someupdate-upd`).
|
|
|
|
|
|
|
|
Once the coding is done, the branch will be merged and then deleted.
|
|
|
|
|
|
|
|
### Branch Workflow
|
|
|
|
|
|
|
|
- A new feature is required (e.g. a barometer driver)
|
|
|
|
- A new branch called `barometer` is created from `main` (you can do it locally)
|
|
|
|
- A new branch called `barometer-dev` is created from `main` (you can do it locally)
|
|
|
|
|
|
|
|
```
|
|
|
|
git pull
|
|
|
|
git checkout -b barometer
|
|
|
|
git checkout -b barometer-dev
|
|
|
|
```
|
|
|
|
|
|
|
|
- Commits are made on the branch
|
| ... | ... | |
