This document describes instructions and best practices for contributing to this repository.
Fork the course repository, revise content, then submit.
NOTE: All contributors must abide by course policies.
NOTE: Most files in this repository are written in a syntax called Markdown. For reference, see this Markdown Cheatsheet.
NOTE: Please familiarize yourself with the Git CLI Overview before attempting Git CLI-related sections of this guide.
Fork the course repository via the GitHub.com interface to create a copy under the ownership of your own GitHub user:
You should now be able to view your fork online at https://github.com/YOUR_GITHUB_USERNAME/nyu-info-2335-70-201706.
To revise content, use a Git Client of choice. Refer to the instructions below depending on which you choose.
Add or revise files using the online interface. For example:
For additional support in performing these processes, reference the Git CLI Overview, but skip the first section titled "Initialize Local Repository".
Configuring Remotes is a process you should perform once following an initial "clone" or download of the course repository to your local machine.
Updating your Fork is a process you should perform before attempting to revise contents of the course repository. You are encouraged to also update your fork at the beginning of class, or any other time you would like your fork to reflect the most up-to-date information from the course repository.
Revising Content is a process you should perform only after updating your fork, to prepare a project or some other course content for submission.
Navigate to your Desktop, or some other directory where you would like to download the course repository:
# Mac OS:
cd ~/Desktop # or some other directory where you'd like to download the repository
# Windows OS:
cd C:\Users\YOUR_USERNAME\Desktop\ # where YOUR_USERNAME is the name of the user currently operating your local machineClone your remote fork to your local machine:
git clone https://github.com/YOUR_GITHUB_USERNAME/nyu-info-2335-70-201706.git # feel free to use the SSH version if you've done this kind of thing before: [email protected]:YOUR_GITHUB_USERNAME/nyu-info-2335-70-201706.git
cd nyu-info-2335-70-201706/If this is the first time you are downloading the fork, also add a remote address to track changes from the original course repository:
git remote -v # lists all current remotes. you should see "origin" here pointing to your fork.
git remote add upstream https://github.com/prof-rossetti/nyu-info-2335-70-201706.git # or use the SSH version if you are used to doing that: [email protected]:prof-rossetti/nyu-info-2335-70-201706.git
git remote -v # you should now also see an "upstream" remote pointing to the original course repository.If the course repository has changed since you last interacted with it (most situations), update your local fork by pulling changes from the "upstream" course repository:
git branch # to see which branch you are on (if you are using branches)
git checkout master # to make sure you are on the master branch (if you are using branches)
git pull upstream master
git push origin masterAlternatively, if something unexpected is happening and you would like to overwrite your fork based on the current state of the upstream course repository, forcibly pull from the course repository, but recognize this may delete any outstanding open Pull Requests you have submitted, so perform these operations with care, only when you don't have an outstanding Pull Request waiting to be merged:
git fetch upstream
git checkout master
git reset --hard upstream/master
git push origin master --forceAdd or revise files using a text editor (e.g. Atom):
atom . # this will open the directory in your text editor, allowing you to use to to edit file contentsReview your changes:
git status
git diffCommit the changes when you are satisfied:
git add .
git commit -m "Some description of the changes"Push the changes to your fork:
git push origin masterYou should now be able to view your changes reflected online in your own fork.
After your fork contains the changes you'd like to be included in the course repository, create a Pull Request (PR) using the GitHub online interface. For example:
In the PR message, describe what changes you made and why.
An instructor should review your PR within a timely manner. If an instructor accepts your changes, he will merge them into the course repository's master branch, at which point you should be able to view your changes reflected in the course repository. Else if there are issues with the submission, the instructor should provide further instruction by commenting on the PR, and may close it.
Congratulations! 👏 Thanks! 🙏