From c77276efdd665d6e8a332203890136944f4c05bd Mon Sep 17 00:00:00 2001 From: Sebastian Crane Date: Sun, 27 Feb 2022 22:10:55 +0000 Subject: [PATCH] Add CONTRIBUTING.md document Signed-off-by: Sebastian Crane --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4c5eabb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ + + + +# Contributing to `matchbot` + +Thank you for your interest in improving `matchbot`! +Here are some guidelines that will be useful to keep in mind through the process of submitting changes. + +1. Make a personal fork of this repository on the [LibreGaming Git server](https://git.libregaming.org/) to push changes to (ask for an account on the Git server if you don't already have one). + +2. Write meaningful Git commit messages - [here is a good guide for that](https://cbea.ms/git-commit/). + +3. After pushing your changes to your personal fork, make a pull request with the web interface or with the [`tea` command-line client](https://gitea.com/gitea/tea). +Make sure to wait a few days to let others comment on your changes. + +4. If there are no objections and you've resolved any issues that might have been brought up, rebase the commits onto the `master` branch. +If there are many commits, consider 'squashing' them into one with a single meaningful message when rebasing.