Skip to content
MegaMech edited this page Apr 11, 2023 · 2 revisions

Creating a Github PR

Fork the project and navigate to it.
image

Notice the default branch of master
image

Never modify the master branch, doing so will create conflicts with the base repo. Only use it to sync/update the fork to the latest version (commit).

Instead, create a new branch to work off.
image

Open a terminal and clone the fork

mkdir <branch_name>
cd <branch_name>
git clone --branch <branch_name> https://github.com/USERNAME/mk64
cd mk64

Now open this folder using VSCode's WSL mode. See https://code.visualstudio.com/docs/remote/wsl-tutorial for more info.

VSCode will track the changes made in the Source Control tab. image

Sync Changes to Online Branch

Stage the changes in the Source Control tab. image

In the input box that says Message type in a commit name then hit enter.

Finally, click the Sync button to merge the changes with the online branch.

Submitting a PR

Goto the mk64 repo on Github. Either the base repo or the fork will work. A UI panel will pop up saying you made changes recently and if you would like to create a Pull Request click the buttons and follow the steps.

The UI looks similar (but not exactly) to this image

Now your PR will show up in the Pull Requests tab on the base repo. After an extensive review and requested changes have been made, a reviewer can merge the changes into the base repo.

Clone this wiki locally