mirror of
https://github.com/hassio-addons/addon-base.git
synced 2025-05-03 18:31:26 +00:00
🚀 📚 Added CodeClimate, updated Markdown files to pass linter
This commit is contained in:
parent
3ae721d99f
commit
543125f533
7 changed files with 34 additions and 15 deletions
12
.codeclimate.yml
Normal file
12
.codeclimate.yml
Normal 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
5
.github/ISSUE_TEMPLATE.md
vendored
|
@ -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)
|
||||
|
|
6
.github/PULL_REQUEST_TEMPLATE.md
vendored
6
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -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/
|
1
.mdlrc
Normal file
1
.mdlrc
Normal file
|
@ -0,0 +1 @@
|
|||
rules "~MD024"
|
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
12
README.md
12
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?
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue