Anyone with a GitHub account can propose changes to files in this repository. This document describes instructions and best practices for contributing to this repository. If you are a student unfamiliar with Git and GitHub, please consult the official Git guides or the professor's Git notes, or ask the professor for a crash course.
Fork the course repository via the GitHub.com online interface to create a copy under the ownership of your own GitHub user. After doing so, you should be able to view your fork online at https://github.com/YOUR_GITHUB_USERNAME/georgetown-opim-243-201901.
Clone your fork to download it onto your computer:
git clone https://github.com/YOUR_GITHUB_USERNAME/georgetown-opim-243-201901.git # this is the HTTPS address, but alternatively you can use the SSH address
cd georgetown-opim-243-201901By cloning, you should see a remote address called "origin" has already been established between your local repository and your forked remote repo.
git remote -v
#> origin https://github.com/YOUR_GITHUB_USERNAME/georgetown-opim-243-201901.git (fetch)
#> origin https://github.com/YOUR_GITHUB_USERNAME/georgetown-opim-243-201901.git (push)Finally, also establish a relationship between your local repo and the "upstream" remote repo, which will allow you to keep your fork up-to-date:
git remote add upstream https://github.com/prof-rossetti/georgetown-opim-243-201901.git # this is the HTTPS address, but alternatively you can use the SSH address
git remote -v
#> origin https://github.com/YOUR_GITHUB_USERNAME/georgetown-opim-243-201901.git (fetch)
#> origin https://github.com/YOUR_GITHUB_USERNAME/georgetown-opim-243-201901.git (push)
#> upstream https://github.com/prof-rossetti/georgetown-opim-243-201901.git (fetch)
#> upstream https://github.com/prof-rossetti/georgetown-opim-243-201901.git (push)If you have previously forked the course repository and now your fork is out of date / behind the "upstream" course repository, then follow these steps to refresh your fork from the command-line (Terminal or Git Bash):
git branch # make sure you are on the "master" branch
git pull upstream master # update your local repo to reflect the contents of the "upstream" remote repository
git push origin master # update your "origin" remote repo to reflect the contents of your local repoNOTE: after fetching, if you see conflicts when you pull or push, run:
git reset --hard upstream masterto do a hard reset.
WARNING: refreshing your fork will delete any previous changes you have committed there that aren't reflected in the "upstream" course repository. So make sure any outstanding Pull Requests have been merged before refreshing your fork!
To revise content, navigate to a file in your forked repository via the GitHub.com online interface, then click the "pencil" icon to reveal an online text editor. When done editing a file, "commit" to save the changes. After doing so, you should be able to view your changes reflected online in your own fork.
NOTE: Most files in this repository are written in a syntax called Markdown. For reference, see this Markdown Cheatsheet.
After your fork contains the changes you'd like to be included in the course repository, navigate to the original course repository and create a Pull Request (PR) using the GitHub.com online interface. In the PR message, describe what changes you made and why.
An instructor should review your PR within a timely manner. If the instructor accepts your changes, the instructor 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! 🙏