From 5f020d213d8460df4604ec307a470ae693ed8825 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 21 Jan 2020 18:09:10 +0100 Subject: [PATCH] Update issue and PR templates (#11836) * Update issue and PR templates * Remove lorem ipsum * Small wording improvement * Update .github/ISSUE_TEMPLATE/config.yml Co-Authored-By: Bram Kragten Co-authored-by: Bram Kragten --- .github/ISSUE_TEMPLATE/DOCS_ISSUE.md | 11 +++++++ .github/ISSUE_TEMPLATE/config.yml | 14 +++++++++ .github/PULL_REQUEST_TEMPLATE.md | 45 ++++++++++++++++++++++++---- 3 files changed, 65 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/DOCS_ISSUE.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/DOCS_ISSUE.md b/.github/ISSUE_TEMPLATE/DOCS_ISSUE.md new file mode 100644 index 00000000000..878ec4b21cb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/DOCS_ISSUE.md @@ -0,0 +1,11 @@ +--- +name: Website/Docs bug report +about: Report incorrect/missing information or other issues with our website. +--- +## The problem + + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..4270779b426 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Report a bug/issue with Home Assistant itself + url: https://github.com/home-assistant/home-assistant/issues + about: This is the issue tracker for our website. Please report issues with Home Assistant in the main repository. + - name: I have a question or need support + url: https://www.home-assistant.io/help + about: We use GitHub for tracking bugs, check our website for resources on getting help. + - name: Feature Request + url: https://community.home-assistant.io/c/feature-requests + about: Please use our Community Forum for doing feature requests. + - name: I'm unsure where to go + url: https://www.home-assistant.io/join-chat + about: If you are unsure where to go, then joining our chat is recommended; Just ask! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 439b1e26c04..3b14fa350b9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,46 @@ -**Description:** +## Proposed change + -**Pull request in home-assistant (if applicable):** home-assistant/home-assistant# -## Checklist: +## Type of change + -- [ ] Branch: `next` is for changes and new documentation that will go public with the next Home Assistant release. Fixes, changes and adjustments for the current release should be created against `current`. -- [ ] The documentation follows the [standards][standards]. +- [ ] Spelling, grammar or other readability improvements (`current` branch). +- [ ] Adjusted missing or incorrect information in the current documentation (`current` branch). +- [ ] Added documentation for a new integration I'm adding to Home Assistant (`next` branch). +- [ ] Added documentation for a new feature I'm adding to Home Assistant (`next` branch). +- [ ] Removed stale or deprecated documentation. + +## Additional information + + +- Link to parent pull request in the codebase: +- This PR fixes or closes issue: + +## Checklist + + +- [ ] This PR uses the correct branch, based on one of the following: + - I made a change to the existing documentation and used the `current` branch. + - I made a change that is related to an upcoming version of Home Assistant and used the `next` branch. +- [ ] The documentation follows the Home Assistant documentation [standards][]. [standards]: https://developers.home-assistant.io/docs/documentation_standards.html