Skip to content

Latest commit

 

History

History
131 lines (68 loc) · 4.67 KB

submit.md

File metadata and controls

131 lines (68 loc) · 4.67 KB

How to Submit the Assignment

There are many small programming assignments. These assignements needs to be submitted using pull request functionality of the GitHub.

Making Your Repository using GitHub Classroom

The assignments need to be submitted using "pullrequest" functionality of the GitHub. Using the system called "GitHub Classroom", each student makes his/her own private repository that is a copy of "https://github.com/ACG-2022S/acg". If a student has a GitHub account named <username>, the name of the repository will be acg-<username>. The private repository is only visible from the student and the instructor. In the second class, It will be shown how to make your own class repository using GitHub classroom.

Overview

Let's assume you are looking at the repository acg-<username> (e.g., pba-nobuyuki83) and the task<task number> is the assignment (e.g., task2). The submission is made by

  1. create a branch of the name task<task number>
  2. follow the instruction written in acg-<username>/task<task number>/README.md
  3. push the repository with the branch task<task number>
  4. make a pull request on GitHub page
  5. Instructor will close the pull request after grading.

Setup C++ Programming Environment

First of all, you need to setup C++ Probramming environment (git, cmake, c++ compilar)

Clone the Repository

If you don't have the local repository in your computer, clone it from the remote repository

$ git clone https://github.com/ACG-2022S/acg-<username>.git

Before doing each assignment, synchronize the local repository to the remote repository.

$ cd acg-<username>   # go to the local repository
$ git checkout main   # set main branch as the current branch
$ git fetch origin main   # download the main branch from remote repository
$ git reset --hard origin/main   # reset the local main branch same as remote repository

Setup Libraries

For all the assignement, we use GLFW Library for OpenGL visualization. Please take a look at the following document

Install Eigen, which is a library for matrix operation. Please follow the following document for setting up.

Finally, install DelFEM2 in acg-<username>/external . DelFEM2 is a collection of useful C++ codes written by the instructer. Please install and updte this library with the following command.

$ cd acg-<username> # go to the top of local repository
$ git submodule update --init external/delfem2

Make Branch for Each Assignment

Create the task<number> branch and set it as the current branch. For task01 the commands look like

$ git branch task01    # create task1 branch
$ git checkout task01  # switch into the task1 branch
$ git branch -a       # make sure you are in the task1 branch

Now, you are ready to edit the code and do the assignment!

Do the Assignment

Edit the code and this mark down document.

Upload the Change

After you finish editing, you submit the updates pushing to the task<number> branch of the remote repository. For task1 the command look like

cd acg-<username>    # go to the top of the repository
git branch -a  #  make sure again you are in the task1 branch
git status  # check the changes (typically few files are shown to be "updated")
git add .   # stage the changes
git status  # check the staged changes (typically few files re shown to be "staged")
git commit -m "task1 finished"   # the comment can be anything
git push --set-upstream origin task01  # update the task1 branch of the remote repository

Make a Pull Request

Go to the GitHub webpage https://github.com/ACG-2022S/acg-<username> . If everything looks good on this page, make a pull request.

Tips for Git / GitHub

  • Do not put any binary files (e.g., executable, binary files) except for image files. Put only readable files in the repository.

  • If many binary files are shown when I type git status, write the files/directories you want to ignore into acg-<username>/.gitignore.

  • If somethig goes wrong, put the local repository somewhere and start again from cloning the repositotry.

  • If you get errors, try to read them. If you do not understand what the error says, search the error message on the web.

  • If you mistakenly submit the assignement in the main branch, make a branch task<number> and submit again.