Documentation tweaks

This commit is contained in:
Franck Nijhof 2021-01-22 10:09:10 +01:00
parent 584938bf81
commit 2299db9ea3
No known key found for this signature in database
GPG key ID: D62583BA8AB11CA3
4 changed files with 7 additions and 72 deletions

View file

@ -1,46 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- 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
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

View file

@ -1,17 +0,0 @@
# Contributing
You are welcome to edit, fork and create pull requests as you like.
- If you make a change, make sure to refer to any issues that it fixes.
- Make sure you have used linters and tested what you have added/changed
works.
- Any pull request will be verified by the bots, so make sure you fix any
issues the bots find.
- I, and any other users I approve will be able to merge your changes so
be patient.
## Docs
Feel free to improve documentation as you like by making a pull request in
`/docs`. Once merged into the master branch, my ci server will update the
docs in the `gh-pages` branch.

View file

@ -10,7 +10,7 @@
![Supports amd64 Architecture][amd64-shield] ![Supports amd64 Architecture][amd64-shield]
![Supports i386 Architecture][i386-shield] ![Supports i386 Architecture][i386-shield]
[![GitLab CI][gitlabci-shield]][gitlabci] [![Github Actions][github-actions-shield]][github-actions]
![Project Maintenance][maintenance-shield] ![Project Maintenance][maintenance-shield]
[![GitHub Activity][commits-shield]][commits] [![GitHub Activity][commits-shield]][commits]
@ -101,16 +101,16 @@ SOFTWARE.
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg [buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/timmo [buymeacoffee]: https://www.buymeacoffee.com/timmo
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-thelounge.svg [commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-thelounge.svg
[commits]: https://github.com/hassio-addons/addon-thelounge/commits/master [commits]: https://github.com/hassio-addons/addon-thelounge/commits/main
[contributors]: https://github.com/hassio-addons/addon-thelounge/graphs/contributors [contributors]: https://github.com/hassio-addons/addon-thelounge/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e [discord-ha]: https://discord.gg/c5DvZ4e
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
[discord]: https://discord.me/hassioaddons [discord]: https://discord.me/hassioaddons
[docs]: https://github.com/hassio-addons/addon-thelounge/blob/master/thelounge/DOCS.md [docs]: https://github.com/hassio-addons/addon-thelounge/blob/main/thelounge/DOCS.md
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/?u=timmo001 [forum]: https://community.home-assistant.io/?u=timmo001
[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-thelounge/badges/master/pipeline.svg [github-actions-shield]: https://github.com/hassio-addons/addon-thelounge/workflows/CI/badge.svg
[gitlabci]: https://gitlab.com/hassio-addons/addon-thelounge/pipelines [github-actions]: https://github.com/hassio-addons/addon-thelounge/actions
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[issue]: https://github.com/hassio-addons/addon-thelounge/issues [issue]: https://github.com/hassio-addons/addon-thelounge/issues
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-thelounge.svg [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-thelounge.svg
@ -120,5 +120,5 @@ SOFTWARE.
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-thelounge.svg [releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-thelounge.svg
[releases]: https://github.com/hassio-addons/addon-thelounge/releases [releases]: https://github.com/hassio-addons/addon-thelounge/releases
[repository]: https://github.com/hassio-addons/repository [repository]: https://github.com/hassio-addons/repository
[screenshot]: https://raw.githubusercontent.com/hassio-addons/addon-thelounge/master/images/screenshot.png [screenshot]: https://raw.githubusercontent.com/hassio-addons/addon-thelounge/main/images/screenshot.png
[timmo]: https://github.com/timmo001 [timmo]: https://github.com/timmo001

View file

@ -89,8 +89,7 @@ A list of users to setup. At first, these will use the default password
## Changelog & Releases ## Changelog & Releases
This repository keeps a change log using [GitHub's releases][releases] This repository keeps a change log using [GitHub's releases][releases]
functionality. The format of the log is based on functionality.
[Keep a Changelog][keepchangelog].
Releases are based on [Semantic Versioning][semver], and use the format Releases are based on [Semantic Versioning][semver], and use the format
of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
@ -151,7 +150,6 @@ SOFTWARE.
[discord]: https://discord.me/hassioaddons [discord]: https://discord.me/hassioaddons
[forum]: https://community.home-assistant.io/?u=timmo001 [forum]: https://community.home-assistant.io/?u=timmo001
[issue]: https://github.com/hassio-addons/addon-thelounge/issues [issue]: https://github.com/hassio-addons/addon-thelounge/issues
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
[reddit]: https://reddit.com/r/homeassistant [reddit]: https://reddit.com/r/homeassistant
[releases]: https://github.com/hassio-addons/addon-thelounge/releases [releases]: https://github.com/hassio-addons/addon-thelounge/releases
[semver]: http://semver.org/spec/v2.0.0.htm [semver]: http://semver.org/spec/v2.0.0.htm