From 789a0b05de71a91200e697f4064106a540eee3fd Mon Sep 17 00:00:00 2001 From: Mihai Fufezan Date: Mon, 11 Nov 2024 21:22:56 +0200 Subject: [PATCH] Add contributing guidelines --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8eb9317..d14cb0e 100644 --- a/README.md +++ b/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. 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 -This repository is licensed under the [BSD 3-Clause License](LICENSE). +This repository is licensed under the [BSD 3-Clause License](./LICENSE).