From cd21142d5beb9233be977ab84b0bb9650a710435 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 27 Feb 2016 23:17:20 +0100 Subject: [PATCH] Update with comments from PR --- .github/ISSUE_TEMPLATE.md | 35 ++++++++++++++++++++++++-------- .github/PULL_REQUEST_TEMPLATE.md | 35 ++++++++++++++++++++------------ 2 files changed, 48 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d5af5533dbf8..7b5a0f1980ff 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,14 +1,31 @@ -Please add a meaningful title and a short description of your issue. It's hard to help you if you only add a trackback with no comments or a one-liner. +**Home Assistant release (`hass --version`):** -Add the following details to your report. Especially if you are unsure about that to include. -- [ ] Your Home Assistant release, `hass --version` -- [ ] Your operating system -- [ ] The component/platform involved -- [ ] The config entry for the component/platform from your `configuration.yml` file -- [ ] Your traceback +**Python release (`python3 --version`):** -It helps if you use the formatting options provided by GitHub ;-) -Anyway, make sure that you have **searched** the closed issues first. Thanks! +**Component/platform:** + + +**Description of problem:** + + +**Expected:** + + +**Problem-relevant `configuration.yaml` entries and steps to reproduce:** +```yaml + +``` + +1. +2. +3. + +**Traceback (if applicable):** +```bash + +``` + +**Additional info:** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ad8566ecba27..7f63274df03f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,28 @@ -This Pull Request includes a +**Description:** -- [ ] Bug fix -- [ ] New component -- [ ] New platform - -The following changes were made: - -- -- -- - -Example entry for the `configuration.yaml` file (if it's a PR for a component/platform): +**Related issue (if applicable):** # +**Example entry for `configuration.yaml` (if applicable):** ```yaml ``` -If this PR is related to an existing ticket, please include a link to it as well. Thanks! +**Checklist:** + +- [ ] Local tests with `tox` ran successfully. +- [ ] No CI failures. **Your PR cannot be merged unless CI is green!** +- [ ] [Fork is up to date][fork] and was rebased on the `dev` branch before creating the PR. +- If code communicates with devices: + - [ ] 3rd party library/libraries for communication is/are added as dependencies via the `REQUIREMENTS` variable ([example][ex-requir]). + - [ ] 3rd party dependencies are imported inside functions that use them ([example][ex-import]). + - [ ] `requirements_all.txt` is up-to-date, `script/gen_requirements_all.py` ran and the updated file is included in the PR. + - [ ] New files were added to `.coveragerc`. +- If the code does not depend on external Python module: + - [ ] Tests to verify that the code works are included. +- [ ] [Commits will be squashed][squash] when the PR is ready to be merged. + +[fork]: http://stackoverflow.com/a/7244456 +[squash]: https://github.com/ginatrapani/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit +[ex-requir]: https://github.com/balloob/home-assistant/blob/dev/homeassistant/components/keyboard.py#L16 +[ex-import]: https://github.com/balloob/home-assistant/blob/dev/homeassistant/components/keyboard.py#L51 +