docs: readme and pull request template outlining how to contribute to this project while upholding the Unlicense

This commit is contained in:
2025-04-22 16:34:12 -04:00
parent c95d2f8d99
commit de3ab27414
2 changed files with 58 additions and 0 deletions

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# smart home in Rust with Home Assistant
You probably don't want to use this if you're not me.
## Unlicense & Contributing
The contents of this repository are released under the [Unlicense](UNLICENSE).
Please create an issue before working on a pull request. It's helpful for you to know if the idea you have in mind will for sure be incorporated into the project, and won't require you to acquaint yourself with the project internals. It even opens the floor for someone else to do the work implementing it for you.
Some [existing issues are labeled straightforward](https://gitea.katniss.top/jacob/smart-home-in-rust-with-home-assistant/issues?labels=42) and expected to be the easiest to work on, if you'd like to try.
Any pull request you make to this repository must
1. contain exclusively commits that are [cryptographically verified](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) to have been authored by you.
2. be explicitly dedicated to the public domain. You can do this by retaining the copywright waiver in [the pull request template](PULL_REQUEST_TEMPLATE).
Your contribution will be declined if it does not ensure this project remains completely free and unencumbered by anyone's copyright monopoly.