Welcome and thank you for your interest in contributing to Wizardry open source project. This document aims to describe the preferred workflow contributors should follow when contributing new source code to the project. This Git workflow is inspired greatly by the irON-Parsers Contributors Guide.
A collaborator is someone with write access to the Wizardry repository. Collaborators merge pull requests from contributors.
A contributor can be anyone! It could be you. Continue reading this section if you wish to get involved and contribute back to the Wizardry open source project!
Code reviewers will be expecting to see code that follows Python guidelines.
- Setup a GitHub account
- Fork the repository of the project
- Clone your fork locally
$ git clone https://github.com/ssantoshp/Wizardry.git- Navigate to the Wizardry directory and add the upstream remote
$ cd Lean
$ git remote add upstream https://github.com/ssantoshp/Wizardry.gitThe remote upstream branch links your fork of Wizardry with our master copy, so when you perform a git pull --rebase you'll be getting updates from our repository.
Now that you've defined the remote upstream branch, you can refresh your local copy of master with the following commands:
$ git checkout master
$ git pull --rebase