From de3ab27414ed08a6185bb64d61b1b4e41c024501 Mon Sep 17 00:00:00 2001
From: Jacob <jacob@katniss.top>
Date: Tue, 22 Apr 2025 16:34:12 -0400
Subject: [PATCH] docs: readme and pull request template outlining how to
 contribute to this project while upholding the Unlicense

---
 PULL_REQUEST_TEMPLATE | 41 +++++++++++++++++++++++++++++++++++++++++
 README.md             | 17 +++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 PULL_REQUEST_TEMPLATE
 create mode 100644 README.md

diff --git a/PULL_REQUEST_TEMPLATE b/PULL_REQUEST_TEMPLATE
new file mode 100644
index 0000000..6073fec
--- /dev/null
+++ b/PULL_REQUEST_TEMPLATE
@@ -0,0 +1,41 @@
+# Prior Issue
+<!--
+Please identify the tracked issue relating to this matter, or create one first if it does not yet exist.
+Write it like e.g. 
+* `closes #567` (so that the issue is linked by keyword https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue),
+* `partially addresses #12 and #345`
+->
+
+
+# Future Improvements
+<!--
+Do you believe there's any more work to be done to round out this contribution? Perhaps documentation or testing?
+Any limitations in the feature or solution offered in this code? Anything else you want to say about the contribution?
+Or, like if this is a trivial change, of course you can just say succinctly that this is everything.
+-->
+
+
+---
+
+<!--
+Read, ensure you agree with, and affirm the copyright waiver below by keeping it in this pull request description.
+If you do not agree or cannot or will not fulfill the requirements described, then you must not include it in your contribution. You are recommended not to attempt to submit the contribution to this project in that case.
+-->
+
+# Copyright waiver for <https://gitea.katniss.top/jacob/smart-home-in-rust-with-home-assistant> (mirrored at <https://github.com/babichjacob/smart-home-in-rust-with-home-assistant>)
+
+I dedicate any and all copyright interest in this software to the
+public domain. I make this dedication for the benefit of the public at
+large and to the detriment of my heirs and successors. I intend this
+dedication to be an overt act of relinquishment in perpetuity of all
+present and future rights to this software under copyright law.
+
+To the best of my knowledge and belief, my contributions are either
+originally authored by me or are derived from prior works which I have
+verified are also in the public domain and are not subject to claims
+of copyright by other parties.
+
+To the best of my knowledge and belief, no individual, business,
+organization, government, or other entity has any copyright interest
+in my contributions, and I affirm that I will not make contributions
+that are otherwise encumbered.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d1fcde2
--- /dev/null
+++ b/README.md
@@ -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.