From 3d6e64e2179dcf65b7e4dad6acaadb52f92b2753 Mon Sep 17 00:00:00 2001 From: Hillary Fraley Date: Tue, 4 Oct 2016 16:03:20 -0400 Subject: [PATCH] Revised item phrasing; consistency (#1119) --- source/developers/development_checklist.markdown | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/source/developers/development_checklist.markdown b/source/developers/development_checklist.markdown index ac2638454ac..9982ffaa24e 100644 --- a/source/developers/development_checklist.markdown +++ b/source/developers/development_checklist.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "Checklist" -description: "Overview of the requirements for an improvment for Home Assistant." +title: "Development Checklist" +description: "Overview of the requirements for an improvement for Home Assistant." date: 2016-07-01 20:00 sidebar: true comments: false @@ -10,10 +10,11 @@ footer: true --- -After you finish your work: +Before you commit any changes, check your work against these requirements: - - Check that all dependencies are included via the `REQUIREMENTS` variable in your platform/component and only imported inside functions that use them. - - Add any new dependencies to `requirements_all.txt` if needed. Use `script/gen_requirements_all.py`. - - Update the `.coveragerc` file to exclude your platform if there are no tests available or your new code uses a 3rd party library for communication with the device/service/sensor. - - Provide some documentation for [home-assistant.io](https://home-assistant.io/). It's OK to just add a docstring with configuration details (sample entry for `configuration.yaml` file and alike) to the file header as a start. Visit the [website documentation](/developers/website/) for further information on contributing to [home-assistant.io](https://github.com/home-assistant/home-assistant.github.io). +- All dependencies are included via the `REQUIREMENTS` variable in your platform or component and only imported inside functions that use them +- New dependencies are added to `requirements_all.txt` (if applicable), using `script/gen_requirements_all.py` +- The `.coveragerc` file is updated to exclude your platform if there are no tests available or your new code uses a third-party library for communication with the device, service, or sensor +- Documentation is developed for [home-assistant.io](https://home-assistant.io/) + * It's OK to start with adding a docstring with configuration details (for example, sample entry for `configuration.yaml` file) to the file header. Visit the [website documentation](/developers/website/) for more information about contributing to [home-assistant.io](https://github.com/home-assistant/home-assistant.github.io).