Hyprland/CONTRIBUTING.md

39 lines
818 B
Markdown
Raw Normal View History

2022-04-18 21:56:33 +02:00
2022-04-02 21:15:48 +02:00
# Contributing
2022-04-18 21:56:33 +02:00
*Thank you for considering contributing to **Hyprland**.*
<br>
## Development
Check the**[Wiki]**for debugging instructions.
2022-04-18 22:08:57 +02:00
Afterwards, pick yourself an**[Issue]** <br>
or*implement your own suggestion!*
2022-04-18 21:56:33 +02:00
*As the**Hyprland**is still in its early stages,* <br>
*I'd recommend you stick to bug fixes first.*
<br>
## Pull Requests
- Please follow the ***code style***
- Code must be ***readable***
- **Features** should be ***useful***
- **Bugfixes** should ***works***
2022-04-02 21:15:48 +02:00
2022-04-18 21:56:33 +02:00
- ***Test your changes!***
2022-04-02 21:15:48 +02:00
2022-04-18 22:08:57 +02:00
*Run it on bare metal and* <br>
*check if everything works.*
2022-04-02 21:15:48 +02:00
2022-04-18 21:56:33 +02:00
<!----------------------------------------------------------------------------->
2022-04-02 21:15:48 +02:00
2022-04-18 21:56:33 +02:00
[Issue]: https://github.com/vaxerski/Hyprland/issues
[Wiki]: https://github.com/vaxerski/Hyprland/wiki/Contributing-&-Debugging