From 4b0f0f5f496de79140975774aac9a2340b2f11be Mon Sep 17 00:00:00 2001
From: Jake Stanger <mail@jstanger.dev>
Date: Sun, 14 Aug 2022 14:34:27 +0100
Subject: [PATCH] docs: add contributing guidelines file

---
 CONTRIBUTING.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..7fa946b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+I welcome contributions of any kind with open arms. That said, please do stick to some basics:
+
+- For code contributions:
+  - Fix any `cargo clippy` warnings, using at least the default configuration.
+  - Make sure your code is formatted using `cargo fmt`.
+  - Keep any documentation up to date.
+  - I won't enforce it, but preferably stick to [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) messages.
+
+
+- For PRs:
+  - Please open an issue or discussion beforehand. 
+    I'll accept most contributions, but it's best to make sure you're not working on something that won't get accepted :)
+
+
+- For issues:
+  - Please provide as much information as you can - share your config, any logs, steps to reproduce...