Contributing Standard steps
These are usually what you do for forking big projects
- Fork the repo
- Clone your fork, by running
git clone <github-porject-url>
- Create upstream by running
git remote add upstream https://github.com/UPSTREAM URL
. You will then be able to rungit pull upstream master
to pull any changes from the the original repository since you last forked it). - Create a branch by running
git checkout -b <branch-name>
- Run whatever installation commands. If Python, start a virtual environment
virtualenv env
source bin/env/activate
pip install -r requirements.txt
- Contribute!
- If you get things working, add your changed files with
git add .
and rungit commit -m "insert message here"
to commit your message. - Push your changes to your fork with
git push origin <branch-name>
- Create a pull request
- Iterate on the solution
- Get merged!