TheArchive/mayhem-firmware
1
0
Fork 0
mirror of https://github.com/portapack-mayhem/mayhem-firmware.git synced 2025-11-15 09:03:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add the 'Create PR' part

Benjamin Møller
2024-11-25 22:04:42 +01:00
parent 5f50d813a2
commit 2a6554c4d9
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
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/<own username>/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.