4 Submitting Pull Requests
MagicBot edited this page 3 years ago

You found a bug. You figured out how to fix it. It works great on your MagicBox. You want the community to benefit. How do you get your changes integrated with the Magicbane master codebase?

We will use a real-life example for this. It appears a refactor of the Configuration System was incomplete. The maximum keyclone count was left hardcoded and not pulling from the config. We will for to fix!

keyclonebug

Our first step is to checkout and pull changes from origin/master. We then will create a new branch off master to hold our changes.

Giving your branch a relevant name is Good Form!

checkmaster
branchfixes

Bug squashed!

bugsquashed

Now we can commit and push our changes to the repository.

repopush

This new branch with our bugfix can now be found on the Magicbane repo. Click to create a new Pull Request.

branchlist

We will now give out Pull Request as much information as we can; including assigning a proper label.

pullenter

The Pull Request has now been made. It is time for anyone to chime in and comment on the request. Time for the MagicBane test team to validate the fix on the development server. Perhaps even run your fix live for a week to kick the tires.

Once enough people are in agreement that the change should be made it will be merged into the master branch.

pulledit