|
## Basics
|
|
|
|
If you are completely new to Git and Github, start from reading the [Git Basics](https://git-scm.com/book/en/v2/Getting-Started-Git-Basics)
|
|
If you are completely new to Git and Github, start from reading the [Git Basics](https://git-scm.com/book/en/v2/Getting-Started-Git-Basics)
|
|
or maybe [A Simple Guide to Git](http://rogerdudler.github.io/git-guide/).
|
|
or maybe [A Simple Guide to Git](http://rogerdudler.github.io/git-guide/).
|
|
|
|
|
|
You can also check the [Cheat Sheet](../wiki/Cheat-Sheet) for some quick commands.
|
|
You can also look at the [Cheat Sheet](../wiki/Cheat-Sheet) for some quick commands.
|
|
|
|
|
|
## Branching model
|
|
## About this Repository
|
|
|
|
|
|
|
|
First of all, a few things about this repo:
|
|
|
|
|
|
|
|
* In the [Code](https://github.com/skyward-er/skyward-boardcore) section you can find the build system, the rocket code (in `src/`) and external libraries (in `libs/`).
|
|
|
|
* The [**Projects**](https://github.com/skyward-er/skyward-boardcore/projects) section is where tasks are assigned and updated to keep track of the state of works.
|
|
|
|
* The [**Issues**](https://github.com/skyward-er/skyward-boardcore/issues) section contains all the issues/enhancements that have to be discussed together. If find a bug/problem, that's the right place to post it.
|
|
|
|
* To contribute to this wiki, simply create a [new page](https://github.com/skyward-er/skyward-boardcore/wiki/_new) and start writing some [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
|
|
|
|
|
|
|
|
## Our Branching Model
|
|
|
|
|
|
*This branching model was inspired by <http://nvie.com/posts/a-successful-git-branching-model/>.*
|
|
*This branching model was inspired by <http://nvie.com/posts/a-successful-git-branching-model/>.*
|
|
|
|
|
... | @@ -25,7 +33,7 @@ To make changes to the software you should use **temporary branches**, such as: |
... | @@ -25,7 +33,7 @@ To make changes to the software you should use **temporary branches**, such as: |
|
- `hotfix` branches: when a bug is found on the master, a branch is created to find a fix to that bug.
|
|
- `hotfix` branches: when a bug is found on the master, a branch is created to find a fix to that bug.
|
|
When the problem is solved, the branch will be merged with the master *and* the testing branch before being cancelled.
|
|
When the problem is solved, the branch will be merged with the master *and* the testing branch before being cancelled.
|
|
|
|
|
|
### Standard Workflow
|
|
### Branch Workflow
|
|
|
|
|
|
- A new feature is required (e.g. a barometer driver)
|
|
- A new feature is required (e.g. a barometer driver)
|
|
- A new branch called `barometer-dev` is created from `testing` (you can do it locally)
|
|
- A new branch called `barometer-dev` is created from `testing` (you can do it locally)
|
... | | ... | |