|
|
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 GitLab, 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/).
|
|
|
|
|
|
You can also look at the [Cheat Sheet](../wiki/Cheat-Sheet) for some quick commands.
|
|
|
You can also look at the [Cheat Sheet](Git-Cheat-Sheet) for some quick commands.
|
|
|
|
|
|
## 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).
|
|
|
* In the Files section you can find the build system (`sbs` and `sbs.conf`), the code (in `src/`) and external libraries (in `libs/`).
|
|
|
* The **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.
|
|
|
|
|
|
## Our Branching Model
|
|
|
|
... | ... | @@ -50,13 +48,13 @@ git status |
|
|
git add name-of-modified-file
|
|
|
git commit -m "[BAROMETER] Added barometer driver."
|
|
|
```
|
|
|
- Frequently `git pull` and `git merge testing` to keep aligned to the testing branch.
|
|
|
- Frequently `git pull` and `git rebase testing` (or merge) to keep aligned to the testing branch.
|
|
|
- When it's ready, make sure it's 0 commits behind testing and **TEST** it one last time.
|
|
|
```
|
|
|
python sbs -v
|
|
|
```
|
|
|
- Make a `pull request` to merge the branch back into the testing branch
|
|
|
- In `testing` futher integration tests occur, and then everything is merged on the master
|
|
|
- Make a `merge request` to merge the branch back into the testing branch
|
|
|
- In `testing`, further integration tests occur and then everything is merged on the master
|
|
|
|
|
|
## Commits
|
|
|
Commits are the core of your team work, because they are the way in which you communicate to the team
|
... | ... | @@ -64,7 +62,7 @@ how you changed the code. |
|
|
For this reason, you have to *think* before you commit, and try to write [good commit messages](https://github.com/erlang/otp/wiki/writing-good-commit-messages).
|
|
|
|
|
|
Some simple rules:
|
|
|
1) Write **meaninful commit messages**, with a short explanation on the top and a more specific one under:
|
|
|
1) Write **meaningful commit messages**, with a short explanation on the top and a more specific one under:
|
|
|
|
|
|
```
|
|
|
[Topic] short message
|
... | ... | @@ -84,7 +82,7 @@ Some simple rules: |
|
|
Do this, and everyone will love you - including yourself, when you'll read
|
|
|
your code after a month from when you last wrote it..
|
|
|
|
|
|
2) **One task = One commit**. Not less, not more.
|
|
|
2) **One task = One commit**
|
|
|
|
|
|
Group together in the same commit the changes that were made for the same task:
|
|
|
if you're about to write something like
|
... | ... | @@ -94,4 +92,4 @@ Some simple rules: |
|
|
|
|
|
What's Next
|
|
|
-----------
|
|
|
Now that you know how to work on this repository, you can read the [Coding Guidelines](../wiki/Coding-Guidelines). |
|
|
\ No newline at end of file |
|
|
Now that you know how to work on this repository, you can read the [Coding Guidelines](Coding-Guidelines). |
|
|
\ No newline at end of file |