This document is currently work-in-progress. Any feedback is welcome.
Initial Setup
- Fork the project on GitHub.
- Clone your fork (and enter the project directory).
git clone https://github.com/<your-username>/<project-name>.git
cd <project-name>
- Add the upstream project as a remote.
git remote add upstream https://github.com/eon-com/<project-name>.git
Making Changes
- To make changes, create a new branch.
git checkout -b my-changes
- Add, commit, and push the changes to your fork.
git add .
git commit -m "My changes"
git push origin my-changes
- On GitHub, open a pull request asking for your changes to be integrated.
Updating Your Fork
- To update your fork, pull from the upstream project.
git checkout master
git pull upstream master