From ccf4cd88b2a99d7010b3e3cf4f4d2406046b0cb6 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 25 Oct 2015 15:54:27 +0100 Subject: [PATCH] Add lint and move to markdown for list --- source/developers/index.markdown | 39 ++++++++++++-------------------- 1 file changed, 15 insertions(+), 24 deletions(-) diff --git a/source/developers/index.markdown b/source/developers/index.markdown index 95bd7049eeb..18c1a0d8488 100644 --- a/source/developers/index.markdown +++ b/source/developers/index.markdown @@ -9,9 +9,7 @@ sharing: true footer: true --- -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. +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. 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 %} -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 +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 ```bash 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 requests. - 1. Go to [the Home Assistant repository](https://github.com/balloob/home-assistant) - and click fork in the top right. + 1. Go to [the Home Assistant repository](https://github.com/balloob/home-assistant) and click fork in the top right. 2. Follow steps in the previous section but with your forked repository. 3. Create a new branch to hold your changes
`git checkout -b some-feature` 4. Make the changes you want - 5. Commit the changes
+ 5. Check your changes for style violations
+ `./script/lint` + 6. Commit the changes
`git add .`
`git commit -m "Added some-feature"` - 6. Push your commited changes back to your fork on Github
+ 7. Push your commited changes back to your fork on Github
`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. ### {% linkable_title Further reading %} - +- [Home Assistant Architecture](/developers/architecture.html) +- [Frontend development](/developers/frontend.html) +- [Creating a custom component](/developers/creating_components.html) +- [Adding support for a new platform](/developers/add_new_platform.html) +- [Rest API](/developers/api.html) +- [Website]()/developers/website.html +