diff --git a/PR-process.md b/PR-process.md index c838494..d3fbad6 100644 --- a/PR-process.md +++ b/PR-process.md @@ -1,3 +1,21 @@ + +## Create a PR + +Before you are able to create a PR, you need to fork the Mayhem-Firmware Repository (https://github.com/portapack-mayhem/mayhem-firmware/) to in your own GitHub Repository. +If you are logged in Github, open the Mayhem-Firmware Repository, at the top right you'll find the button `fork`. Click on `create new fork`. + +Now you need to download your own fork to your computer: `git clone https://github.com//mayhem-firmware/ --recursive`. +Now work on the cloned fork of the repository, as usual. Just add/commit the changes. Make sure you are adding meaningful descriptions at each commit. + +After some changes You go back to the browser and open the mayhem-firmware project in your repository. +If you synced your changes with the fork in your repository, on the top of of the code will appear: `This branch is [7 commits ahead of], [6 commits behind] portapack-mayhem/mayhem-firmware:next.` +Click on `[7 commits ahead of]` and the green Button `Create Pull Request` will appear. + +Now you are working in the PortaPack-Mayhem repository. Just follow the instructions and give a meaningful description in your PR. +The approval/merge process starts. + +## Merge Process + In order to get your PR merged into the code base, there are a few checks that need to happen first. * At least one code approver needs to approve your code.