You will need to set up a development environment if you want to start developing a new feature or component for Home Assistant. Please follow these steps to get setup.
Visit the the Home Assistant repository first and click fork in the top right.
We suggest that you setup a virtual environment aka venv before running the setup script.
We suggest that you setup a virtual environment using venv before running the setup script.
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git @@ -114,6 +114,9 @@ $ script/setup
On Windows you can use python setup.py develop instead of the setup script.
After following these steps, running hass will invoke your local installation.
After following these steps, running hass will invoke your local installation.
Home Assistant enforces strict PEP8 style compliance on all code submitted. You can save yourself the hassle of extra commits just to fix style errors by enabling the flake8 git commit hook. It will check your code when you attempt to commit to the repo. It will block the commit if there are any style issues, giving you a chance to fix it.
@@ -164,15 +165,21 @@ $ flake8 --install-hook# Run this from your feature branch -$ git fetch upstream dev # to pull the latest changes into a local dev 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
If rebase detects conflicts, you can repeat the following process until all changes have been resolved:
-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.
+git status will show you the file with the conflict.<<<< | >>>>git add <file> or git add .git rebase --continue