summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvaxerski <43317083+vaxerski@users.noreply.github.com>2022-04-02 21:15:48 +0200
committerGitHub <noreply@github.com>2022-04-02 21:15:48 +0200
commitc13175e2e3c16f3678e997fcdc82d5f761e2c7fd (patch)
tree6857573cd3fd02b89cdf9c4bb9e91022df24ee52
parent49b6e09c3e5030d48e3fe2e05abc44d8782925ec (diff)
Added Contributing guidelines
-rw-r--r--CONTRIBUTING.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..8a340270
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Contributing
+
+Thanks for considering contributing to Hyprland.
+
+To get started, see the [Wiki](https://github.com/vaxerski/Hyprland/wiki/Contributing-&-Debugging) for debugging instructions.
+
+Then, pick yourself an issue or implement your own suggestion!
+
+As Hyprland is early dev, I recommend you stick to the bugs first, then new functionality.
+
+# PR reqs
+- Follow the code style
+- Code must be readable
+- Feature is useful / bugfix works
+- Test your changes! Run it on bare metal and check if everything works.