Hyprland/docs/Contribute.md

33 lines
859 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-19 11:22:28 +02:00
*Thank you for considering contributing to Hyprland.*
2022-04-18 21:56:33 +02:00
## Development
2022-04-19 11:22:28 +02:00
Check the[Wiki]for debugging instructions.
2022-04-18 21:56:33 +02:00
2022-04-19 11:22:28 +02:00
Afterwards, pick yourself an[Issue] orimplement your own suggestion.
2022-04-18 21:56:33 +02:00
2022-04-19 13:47:09 +02:00
An good place to search for things to contribute is the [Projects Page]
2022-04-19 11:22:28 +02:00
*As Hyprlandis still in its early stages of development, I'd recommend you stick to bug fixes first.*
2022-04-18 21:56:33 +02:00
## Pull Requests
2022-04-19 11:22:28 +02:00
- Please follow the code style
2022-04-18 21:56:33 +02:00
2022-04-19 11:22:28 +02:00
- Code must be readable
2022-04-18 21:56:33 +02:00
2022-04-19 11:22:28 +02:00
- Features should be useful
2022-04-18 21:56:33 +02:00
2022-04-19 11:22:28 +02:00
- Test your changes!
2022-04-02 21:15:48 +02:00
2022-04-19 11:22:28 +02:00
*Run it on bare metal and 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
2022-04-19 13:47:09 +02:00
[Projects page]: https://github.com/vaxerski/Hyprland/projects?type=beta