jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Made README and website contributions match, added more detail to website contribution setup details, updated forum link, re-organised getting started and troubleshooting with respect to YAML

Browse source
This commit is contained in:
Lindsay Ward 2016-04-08 23:39:02 +10:00
parent 7fcca47d19
commit c581168e49
7 changed files with 116 additions and 84 deletions
Download patch file Download diff file Expand all files Collapse all files

26
source/developers/index.markdown
View file

@ -9,17 +9,20 @@ sharing: true
footer: true
---
Home Assistant is built from the ground up to be easily-extensible by other developers using components. It uses [Python 3](https://www.python.org/) for the backend and [Polymer (Webcomponents)](https://www.polymer-project.org/) for the frontend.
Home Assistant is built from the ground up to be easily-extensible by other developers using components. It uses [Python 3](https://www.python.org/) for the backend and [Polymer (Web components)](https://www.polymer-project.org/) for the frontend.
Home Assistant is open-source and MIT licensed. The source can be found here:
- [home-assistant](https://github.com/balloob/home-assistant) - Python server-backend
- [home-assistant-js](https://github.com/balloob/home-assistant-js) - javascript-backend powering the client
- [home-assistant](https://github.com/balloob/home-assistant) - Python server backend
- [home-assistant-js](https://github.com/balloob/home-assistant-js) - JavaScript backend powering the client
- [home-assistant-polymer](https://github.com/balloob/home-assistant-polymer) - Polymer UI
### {% linkable_title Starting development %}
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 perform it. Visit the [the Home Assistant repository](https://github.com/balloob/home-assistant) first and click fork in the top right.
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](https://github.com/balloob/home-assistant) first and click fork in the top right.
We suggest that you setup a [virtual environment](https://docs.python.org/3.4/library/venv.html) aka `venv` before running the setup script.
```bash
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
@ -28,13 +31,17 @@ $ git remote add upstream https://github.com/balloob/home-assistant.git
$ script/setup
```
We suggest that you setup a [virtual environment](https://docs.python.org/3.4/library/venv.html) aka `venv` before running the setup script.
Testing your work requires `tox` to be installed:
```bash
$ pip3 install tox
```
After following these steps, running `hass` will invoke your local installation.
### {% linkable_title Submitting improvements %}
Improvements to Home Assistant should be submitted one feature at a time using Github 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).
1. From your fork, create a new branch to hold your changes
`git checkout -b some-feature`
@ -44,15 +51,10 @@ Improvements to Home Assistant should be submitted one feature at a time using G
4. Commit the changes
`git add .`
`git commit -m "Added some-feature"`
5. Push your commited changes back to your fork on GitHub
5. Push your committed changes back to your fork on GitHub
`git push origin HEAD`
6. Follow [these steps](https://help.github.com/articles/creating-a-pull-request/) to create your pull request.
Note that the above requires `tox` to be installed. If you don't have it, do this:
```bash
$ pip3 install tox
```
### {% linkable_title Further reading %}