diff --git a/.codeclimate.yml b/.codeclimate.yml new file mode 100644 index 0000000..afe7c4f --- /dev/null +++ b/.codeclimate.yml @@ -0,0 +1,12 @@ +--- +engines: + fixme: + enabled: true + shellcheck: + enabled: true + markdownlint: + enabled: true +ratings: + paths: + - "**.sh" +exclude_paths: [] diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index fad9895..544da8f 100755 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ -## Problem/Motivation +# Problem/Motivation > (Why the issue was filed) @@ -16,4 +16,5 @@ ## Proposed changes -> (If you have a proposed change, workaround or fix, describe the rationale behind it) +> (If you have a proposed change, workaround or fix, +> describe the rationale behind it) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 57fcd54..cbd529a 100755 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,9 @@ -## Proposed Changes +# Proposed Changes > (Describe the changes and rationale behind them) ## Related Issues -> ([Github link](https://help.github.com/articles/autolinked-references-and-urls/) to related issues or pull requests) +> ([Github link][autolink-references] to related issues or pull requests) + +[autolink-references]: https://help.github.com/articles/autolinked-references-and-urls/ \ No newline at end of file diff --git a/.mdlrc b/.mdlrc new file mode 100644 index 0000000..2b0128d --- /dev/null +++ b/.mdlrc @@ -0,0 +1 @@ +rules "~MD024" \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 64899eb..9b6e9e9 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -22,11 +22,14 @@ include: Examples of unacceptable behavior by participants include: -- The use of sexualized language or imagery and unwelcome sexual attention or advances +- The use of sexualized language or imagery and unwelcome sexual attention + or advances - Trolling, insulting/derogatory comments, and personal or political attacks - Public or private harassment -- Publishing others' private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting +- Publishing others' private information, such as a physical or + electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate + in a professional setting ## Our responsibilities @@ -52,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project lead at frenck@geekchimp.com. All +reported by contacting the project lead at frenck@addon.community. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project lead is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 16327fc..bdcd92d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ Even better: You could submit a pull request with a fix / new feature! 1. Search our repository for open or closed [pull requests][prs] that relates to your submission. You don't want to duplicate effort. -2. You may merge the pull request in once you have the sign-off of two other +1. You may merge the pull request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. diff --git a/README.md b/README.md index f0092f0..40100fe 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ repository contain some extra's: ## Changelog -This repository keeps a [change log](CHANGELOG.md) and adhere to -[Semantic Versioning][semver]. -The format of the log is based on [Keep a Changelog][keepchangelog] +This repository keeps a [change log](CHANGELOG.md) and adhere to +[Semantic Versioning][semver]. The format of the log is based on +[Keep a Changelog][keepchangelog]. ## Support @@ -54,9 +54,9 @@ Got questions? You have several options to get them answered: -- The Home Assistant [Community Forums][forums], we have a +- The Home Assistant [Community Forums][forums], we have a [dedicated topic][forums] on that forum regarding this repository. -- The Home Assistant [Discord Chat Server][discord] for general Home Assistant +- The Home Assistant [Discord Chat Server][discord] for general Home Assistant discussions and questions. - Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] @@ -78,7 +78,7 @@ The original setup of this repository is by [Franck Nijhof][frenck]. For a full list of all authors and contributors, check [the contributor's page][contributors]. -## Looking for Hass.io add-ons? +## We've got some Hass.io add-ons for you Want some more functionality to your Hass.io Home Assistant instance?