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-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Suggest the flake8 git commit hook (#408)

Browse Source 
Given the number of PRs that require style cleanups, it seems like it might be helpful to suggest users add the flake8 commit hook, to catch issues before they get committed to the repo.
This commit is contained in:
Josh Wright 2016-04-19 21:50:29 -04:00 committed by Paulus Schoutsen
parent 2fcb0e9239
commit ca6955ff24
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
source/developers/development_environment.markdown
View File

@ -39,6 +39,15 @@ $ pip3 install tox
After following these steps, running `hass` will invoke your local installation. After following these steps, running `hass` will invoke your local installation.
### {% linkable_title Prevent Linter Errors %}
Home Assistant enforces strict [PEP8 style](https://www.python.org/dev/peps/pep-0008/) 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.
```bash
$ pip install flake8
$ flake8 --install-hook
```
### {% linkable_title Submitting improvements %} ### {% linkable_title Submitting improvements %}
Improvements to Home Assistant should be submitted one feature at a time using GitHub [pull requests](https://help.github.com/articles/using-pull-requests). Improvements to Home Assistant should be submitted one feature at a time using GitHub [pull requests](https://help.github.com/articles/using-pull-requests).