OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

add markdown info for contribution, reformat (#2162) 

Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>
pull/2131/head
stefan-hoehn 2023-11-19 18:09:44 +01:00 committed by GitHub
parent 35c79eead4
commit 85f5ac1b01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
.github/CONTRIBUTING.md vendored
View File

@ -2,53 +2,52 @@
## Pull requests are always welcome ## Pull requests are always welcome
We are always thrilled to receive pull requests, and do our best to We are always thrilled to receive pull requests, and do our best to process them as fast as possible.
process them as fast as possible. Not sure if that typo is worth a pull Not sure if that typo is worth a pull request?
request? Do it! We will appreciate it. Do it!
We will appreciate it.
## Conventions ## Conventions
Fork the repo and make changes on your fork in a feature branch. Fork the repo and make changes on your fork in a feature branch.
Pull requests descriptions should be as clear as possible and include a Any change will be checked against selected **markdown rules**, defined in the [.markdownlint.yaml](.markdownlint.yaml), and will be automatically checked during the build.
reference to all the issues that they address. An explanation of the rules can be found [here](https://github.com/DavidAnson/markdownlint#rules--aliases).
Please make sure that your contributed content is therefore compliant with these rules before contributing them.
Checkout the [markdownlint project](https://github.com/DavidAnson/markdownlint) for support of your favorite IDE.
In doubt, ask us to guide you on these rules.
Pull requests descriptions should be as clear as possible and include a reference to all the issues that they address.
Pull requests must not contain commits from other users or branches. Pull requests must not contain commits from other users or branches.
Commit messages must start with a capitalized and short summary (max. 50 Commit messages must start with a capitalized and short summary (max. 50 chars) written in the imperative, followed by an optional, more detailed explanatory text which is separated from the summary by an empty line.
chars) written in the imperative, followed by an optional, more detailed
explanatory text which is separated from the summary by an empty line.
Code review comments may be added to your pull request. Discuss, then make the Code review comments may be added to your pull request. Discuss, then make the suggested modifications and push additional commits to your feature branch.
suggested modifications and push additional commits to your feature branch. Be Be sure to post a comment after pushing.
sure to post a comment after pushing. The new commits will show up in the pull The new commits will show up in the pull request automatically, but the reviewers will not be notified unless you comment.
request automatically, but the reviewers will not be notified unless you
comment.
Commits that fix or close an issue should include a reference like `Closes #XXX` Commits that fix or close an issue should include a reference like `Closes #XXX` or `Fixes #XXX`, which will automatically close the issue when merged.
or `Fixes #XXX`, which will automatically close the issue when merged.
## Community Guidelines ## Community Guidelines
We want to keep the openHAB community awesome, growing and collaborative. We We want to keep the openHAB community awesome, growing and collaborative.
need your help to keep it that way. To help with this we've come up with some We need your help to keep it that way.
general guidelines for the community as a whole: To help with this we've come up with some general guidelines for the community as a whole:
- Be nice: Be courteous, respectful and polite to fellow community members: no - Be nice:
regional, racial, gender, or other abuse will be tolerated. We like nice people Be courteous, respectful and polite to fellow community members:
way better than mean ones! no regional, racial, gender, or other abuse will be tolerated.
We like nice people way better than mean ones!
- Encourage diversity and participation: Make everyone in our community - Encourage diversity and participation:
feel welcome, regardless of their background and the extent of their Make everyone in our community feel welcome, regardless of their background and the extent of their contributions, and do everything possible to encourage participation in our community.
contributions, and do everything possible to encourage participation in
our community.
- Keep it legal: Basically, don't get us in trouble. Share only content that - Keep it legal:
you own, do not share private or sensitive information, and don't break the Basically, don't get us in trouble.
law. Share only content that you own, do not share private or sensitive information, and don't break the law.
- Stay on topic: Make sure that you are posting to the correct channel - Stay on topic:
and avoid off-topic discussions. Remember when you update an issue or Make sure that you are posting to the correct channel and avoid off-topic discussions.
respond to an email you are potentially sending to a large number of Remember when you update an issue or respond to an email you are potentially sending to a large number of people.
people. Please consider this before you update. Also remember that Please consider this before you update. Also remember that nobody likes spam.
nobody likes spam.