hyprwm/Hyprland
1
0
Fork 0
mirror of https://github.com/hyprwm/Hyprland synced 2024-11-22 15:25:58 +01:00
Code Issues Projects Releases Packages Wiki Activity

Formatted CONTRIBUTING.md

Browse source
This commit is contained in:
ElectronicsArchiver 2022-04-18 15:56:33 -04:00
parent c7d02a38d9
commit 4a958f206e
1 changed files with 30 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
CONTRIBUTING.md
View file

@ -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.
<br>
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,* <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***
- ***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