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-26 02:37:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add lint and move to markdown for list

Browse Source
This commit is contained in:
Fabian Affolter 2015-10-25 15:54:27 +01:00
parent 05992bd779
commit ccf4cd88b2
1 changed files with 15 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
source/developers/index.markdown
View File

@ -9,9 +9,7 @@ sharing: true
footer: true footer: true
--- ---
Home Assistant is build from the ground-up to be easily extensible by other developers using Home Assistant is build 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.
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 open-source and MIT licensed. The source can be found here: Home Assistant is open-source and MIT licensed. The source can be found here:
@ -21,8 +19,7 @@ Home Assistant is open-source and MIT licensed. The source can be found here:
### {% linkable_title Starting development %} ### {% linkable_title Starting development %}
You will need to setup a development environment if you want to start developing a new feature or You will need to setup a development environment if you want to start developing a new feature or component for Home Assistant perform theses steps
component for Home Assistant perform theses steps
```bash ```bash
git clone https://github.com/balloob/home-assistant.git git clone https://github.com/balloob/home-assistant.git
@ -37,33 +34,27 @@ After following these steps, running `hass` will invoke your local installation.
Improvements to Home Assistant should be submitted one feature at a time using Github pull Improvements to Home Assistant should be submitted one feature at a time using Github pull
requests. requests.
1. Go to [the Home Assistant repository](https://github.com/balloob/home-assistant) 1. Go to [the Home Assistant repository](https://github.com/balloob/home-assistant) and click fork in the top right.
and click fork in the top right.
2. Follow steps in the previous section but with your forked repository. 2. Follow steps in the previous section but with your forked repository.
3. Create a new branch to hold your changes<br> 3. Create a new branch to hold your changes<br>
`git checkout -b some-feature` `git checkout -b some-feature`
4. Make the changes you want 4. Make the changes you want
5. Commit the changes<br> 5. Check your changes for style violations<br>
`./script/lint`
6. Commit the changes<br>
`git add .`<br> `git add .`<br>
`git commit -m "Added some-feature"` `git commit -m "Added some-feature"`
6. Push your commited changes back to your fork on Github<br> 7. Push your commited changes back to your fork on Github<br>
`git push origin HEAD` `git push origin HEAD`
7. Follow [these steps](https://help.github.com/articles/creating-a-pull-request/) to create your 8. Follow [these steps](https://help.github.com/articles/creating-a-pull-request/) to create your
pull request. pull request.
### {% linkable_title Further reading %} ### {% linkable_title Further reading %}
<ul> - [Home Assistant Architecture](/developers/architecture.html)
<li><a href="{{ root_url }}/developers/architecture.html"> - [Frontend development](/developers/frontend.html)
Home Assistant Architecture - [Creating a custom component](/developers/creating_components.html)
</a></li> - [Adding support for a new platform](/developers/add_new_platform.html)
<li><a href="{{ root_url}}/developers/frontend.html">Frontend development</a></li> - [Rest API](/developers/api.html)
<li><a href="{{ root_url}}/developers/creating_components.html"> - [Website]()/developers/website.html
Creating a custom component
</a></li>
<li><a href="{{ root_url}}/developers/add_new_platform.html">
Adding support for a new platform
</a></li>
<li><a href="{{ root_url }}/developers/api.html">Rest API</a></li>
<li><a href="{{ root_url }}/developers/website.html">Website </a></li>
</ul>