mirror of
https://github.com/hyprwm/hyprland-wiki.git
synced 2024-11-15 09:45:58 +01:00
Add contributing guidelines
This commit is contained in:
parent
87c7f834fe
commit
789a0b05de
1 changed files with 16 additions and 1 deletions
17
README.md
17
README.md
|
@ -9,6 +9,21 @@ You can find the site at [https://wiki.hyprland.org/](https://wiki.hyprland.org/
|
||||||
Feel free to open an issue or a PR if you feel anything is necessary.
|
Feel free to open an issue or a PR if you feel anything is necessary.
|
||||||
Make sure to clearly state the reason for the changes.
|
Make sure to clearly state the reason for the changes.
|
||||||
|
|
||||||
|
Commits should have the form:
|
||||||
|
|
||||||
|
`Dir/Page: summary of changes`
|
||||||
|
|
||||||
|
Optionally, you can include a longer commit message 2 lines below the commit
|
||||||
|
title.
|
||||||
|
|
||||||
|
This format makes it easier glance over the commit list and figure out what
|
||||||
|
each commit is about.
|
||||||
|
|
||||||
|
Additionally, if you make many changes in your PR, it is best to squash them
|
||||||
|
into self-contained commits that contain one logical change.
|
||||||
|
|
||||||
|
For info about how to squash commits, see [this](https://stackoverflow.com/a/5189600).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This repository is licensed under the [BSD 3-Clause License](LICENSE).
|
This repository is licensed under the [BSD 3-Clause License](./LICENSE).
|
||||||
|
|
Loading…
Reference in a new issue