diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a340270..97c9f42b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,36 @@ + # Contributing -Thanks for considering contributing to Hyprland. +*Thank you 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! +## Development -As Hyprland is early dev, I recommend you stick to the bugs first, then new functionality. +Check the **[Wiki]** for debugging instructions. -# 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. +Afterwards, pick yourself an **[Issue]** or *implement your own suggestion!* + +*As the **Hyprland** is still in its early stages,*
+*I'd recommend you stick to bug fixes first.* + +
+ +## Pull Requests + +- Please follow the ***code style*** + +- Code must be ***readable*** + +- **Features** should be ***useful*** + +- **Bugfixes** should ***works*** + +- ***Test your changes!*** + + *Run it on bare metal and check if everything works.* + + + +[Issue]: https://github.com/vaxerski/Hyprland/issues +[Wiki]: https://github.com/vaxerski/Hyprland/wiki/Contributing-&-Debugging