From 1cbcacadeef9ea281be6f2e53a4baddf331406f6 Mon Sep 17 00:00:00 2001 From: Jakkowww Date: Fri, 12 Jul 2024 18:22:17 +0200 Subject: [PATCH] Add extra info to make contributing easier. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 4b3609a3..35a72225 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ Please use a dedicated repository [pybugreports](https://github.com/pyanodon/pyb ## Contributing +The stable public release is on the "Frozen" branch so if you want to test changes or make a pull request to put your changes into the public repository then you will have to use that branch. +This also means that when forking you will have to deselect "Copy the master branch only" as it is enabled by default. When making a Pull Request, please also update `changelog.txt` with the summary of your changes. If there is no upcoming version in the file, then the format is as follows: ``` @@ -15,3 +17,12 @@ Date: ??? - The summary of your changes --------------------------------------------------------------------------------------------------- ``` + +Here is a quick guide on how to initiate a code review/pull request if you have never done so on Github. + - Fork the repository (button in the top right on Github), it makes a private copy of it. + - Deselect "Copy the master branch only" when making the fork so we also get the "Frozen" branch. + - Clone your fork onto your PC. + - Switch to the "Frozen" branch. + - Make your changes, make your commit(s), test whether they do what you want. + - Push the commit(s) to your private fork repository. + - Use Github to initiate a pull request in your private fork repository (button on the top, says "Compare & pull request"). If you have multiple commits it will create one pull request for all of them together.