hassio-addons/addon-base
1
0
Fork 0
mirror of https://github.com/hassio-addons/addon-base.git synced 2025-05-03 18:31:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

🚀 📚 Added CodeClimate, updated Markdown files to pass linter

Browse source
This commit is contained in:
Franck Nijhof 2017-09-17 21:14:54 +02:00
parent 3ae721d99f
commit 543125f533
No known key found for this signature in database
GPG key ID: D62583BA8AB11CA3
7 changed files with 34 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

12
.codeclimate.yml Normal file
View file

@ -0,0 +1,12 @@
---
engines:
fixme:
enabled: true
shellcheck:
enabled: true
markdownlint:
enabled: true
ratings:
paths:
- "**.sh"
exclude_paths: []

5
.github/ISSUE_TEMPLATE.md vendored
View file

@ -1,4 +1,4 @@
## Problem/Motivation # Problem/Motivation
> (Why the issue was filed) > (Why the issue was filed)
@ -16,4 +16,5 @@
## Proposed changes ## 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)

6
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,7 +1,9 @@
## Proposed Changes # Proposed Changes
> (Describe the changes and rationale behind them) > (Describe the changes and rationale behind them)
## Related Issues ## 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/

1
.mdlrc Normal file
View file

@ -0,0 +1 @@
rules "~MD024"

11
CODE_OF_CONDUCT.md
View file

@ -22,11 +22,14 @@ include:
Examples of unacceptable behavior by participants 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 - Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment - Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission - Publishing others' private information, such as a physical or
- Other conduct which could reasonably be considered inappropriate in a professional setting electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate
in a professional setting
## Our responsibilities ## Our responsibilities
@ -52,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be 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 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 is deemed necessary and appropriate to the circumstances. The project lead is
obligated to maintain confidentiality with regard to the reporter of an incident. obligated to maintain confidentiality with regard to the reporter of an incident.

2
CONTRIBUTING.md
View file

@ -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 1. Search our repository for open or closed [pull requests][prs] that relates
to your submission. You don't want to duplicate effort. 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 developers, or if you do not have permission to do that, you may request
the second reviewer to merge it for you. the second reviewer to merge it for you.

12
README.md
View file

@ -44,9 +44,9 @@ repository contain some extra's:
## Changelog ## Changelog
This repository keeps a [change log](CHANGELOG.md) and adhere to This repository keeps a [change log](CHANGELOG.md) and adhere to
[Semantic Versioning][semver]. [Semantic Versioning][semver]. The format of the log is based on
The format of the log is based on [Keep a Changelog][keepchangelog] [Keep a Changelog][keepchangelog].
## Support ## Support
@ -54,9 +54,9 @@ Got questions?
You have several options to get them answered: 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. [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. discussions and questions.
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] - 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, For a full list of all authors and contributors,
check [the contributor's page][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? Want some more functionality to your Hass.io Home Assistant instance?