jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-12 20:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small note about rebasing (#417)

Browse Source 
* Small note about rebasing
How to keep feature branches current with the remote dev branch

* move the rebasing comments and add a note about interactive squashing of commits
This commit is contained in:
Jamie van Dyke 2016-04-23 09:11:43 +01:00 committed by Fabian Affolter
parent 6ce60ab3b6
commit 83a53a648c
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
source/developers/development_environment.markdown
View File

@ -31,6 +31,8 @@ $ git remote add upstream https://github.com/home-assistant/home-assistant.git
$ script/setup
```
### {% linkable_title Testing your work %}
Testing your work requires `tox` to be installed:
```bash
@ -64,6 +66,20 @@ Improvements to Home Assistant should be submitted one feature at a time using G
`git push origin HEAD`
6. Follow [these steps](https://help.github.com/articles/creating-a-pull-request/) to create your pull request.
### {% linkable_title Catching up with Reality %}
If you're taking a while developing your feature request and would like to catch up with what's in the current Home Assistant dev branch, you can use git rebase to do so. This will pull the latest Home Assistant changes locally, rewind your commits, bring in the latest changes from Home Assistant and then replay all of your commits on top.
```bash
# Run this from your feature branch
$ git fetch upstream dev # to pull the latest changes into a local dev branch
$ git rebase upstream/dev # to put those changes into your feature branch before your changes
```
### {% linkable_title Squashing your commits %}
Your feature is done, it looks great and the tests are all passing. What now? Squash your commits, and create a pull request. Squashing your commits makes for a more readable git commit history. It's an interactive process that is best explained by Matt Stauffer in [this video](https://www.youtube.com/watch?v=7IfkL8swmFw).
### {% linkable_title Further reading %}
@ -74,4 +90,3 @@ Improvements to Home Assistant should be submitted one feature at a time using G
- [Rest API](/developers/api/)
- [Server-sent events](/developers/server_sent_events/)
- [Website](/developers/website/)