From c13175e2e3c16f3678e997fcdc82d5f761e2c7fd Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Sat, 2 Apr 2022 21:15:48 +0200 Subject: [PATCH] Added Contributing guidelines --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md 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.