| [Syllabus] | [Schedule] | [Resources] | [Github] |
We will use the fork and pull request workflow for submissions in this class. The idea is that you will make the required changes in your own copy, and then submit a pull request and @mention me (@rivlev). The pull request and @mention comprise your submission for this assignment.
Github Classroom will create a remote repository for you that is seeded with startup code. First, clone the repository to make a local copy on your own machine. You will make changes to the code on your own computer and sync between the local and remote copies.
In a terminal window, navigate to the directory where you want to keep the repository. Since you will be creating multiple repositories for this class, you may want to organize them in a directory structure such as cisc3620/labs/.
From the online github repository page, copy the url of your repository. You can get it from the green “clone or download” button near the top right of the window.
In the terminal, do
git clone --recursive <THE_URL>
Cmake will generate a makefile for the openGL project. If you don’t have cmake installed on your machine, get it from (http://www.cmake.org/download/).
Navigate to the Build subdirectory (one down from the top of the repository).
Choose the appropriate command for your platform and IDE:
# Unix Makefile
cmake ..
# Mac OSX
cmake -G "Xcode" ..
# Microsoft Windows
cmake -G "Visual Studio 14" ..
cmake -G "Visual Studio 14 Win64" ..
Before you make any changes, create and switch to a new branch
git checkout -b hw
This will make sure the original master branch stays clean, so you can merge back into it with the pull request and have the differences all apparent in one place.
Edit the project files to fulfill the assignment requirements.
If you are running into difficulty with your project you can ask for help by opening an issue and @mentioning me (@rivlev). Please note that full-scale debugging or code review can only happen during office hours.
From the top level of the repository:
git add doc1 doc2 doc3
(for all files you have modified).
This prepares these files to be included in the next git commit. Make sure to do this after you’ve made the changes you want to save.
git commit -m "message"
This records a snapshot of the changes you’ve made. Make sure to include a meaningful message so you know what this update was for.
git push origin hw
Go back to your Github repository page. Click “New pull request”. “Base” should be “master” (the branch you want to make changes to), “Compare” should be “hw” (the branch with the changes you want to make).
You should see a preview of the changes you made (called a “diff”).
Click “Create pull request”.
In the subject line, write a tiny summary of your changes. In the body, fill out the pull request template. Make sure it includes your name and @rivlev.
Click “Create pull request”. This will notify me of your submission.