This project is work of many contributors. You're encouraged to submit pull requests, propose features and discuss issues.
In the examples below, substitute your Github username for contributor
in URLs.
Fork the project on Github and check out your copy.
git clone https://github.com/<contributor>/cs5356.git
cd cs5356
git remote add upstream https://github.com/CT-CS5356-Fall2017/cs5356.git
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
git checkout master
git pull upstream master
git checkout -b my-feature-branch
Add your document, or make changes.
Make sure git knows your name and email address:
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
Writing good commit logs is important. A commit log should describe what changed and why.
git add ...
git commit
git push origin my-feature-branch
Go to https://github.com/``/cs5356 and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a day or two.
If you've been working on a change for a while, rebase with upstream/master.
git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
Please do know that we really appreciate and value your time and work. We love you, really.