Ctrl+K

Submitting Your Assignment / Project

Submitting Your Assignment / Project#

Step 1: Github Repository#

This step will only need to be done once - at the beginning of the semester. You need two private repositories, one for the assignments and another for the project. Name them as follows:

cs301-project

cs301-assignments

Obvioulsy, replace cs301 with your course number. Please comply to all lower case fomat for directory files and (directory) names.

Do not create the repository before watching the video below that although refers to a specific course (CS370) it is applicable to all courses.

As part of the process outlined in the video, you need to copy this github action and edit line 34 so that only the Github ID of your TA for your course is included.

For assignments you need to create a separate folder for each assignment: e.g assignment-1. You need to include a README.md file in each assignment folder. The README.md file should include the following information:

  • Name of the assignment

  • Date of submission

  • Instructions on how to run the code

  • Instructions on how to run any tests (if applicable)

  • Instructions on how to run any notebook (if applicable)

Make sure you know how to commit and push your changes to your repo. If you do not push the latest changes the grader will grade an outdated version of your code.

  1. Go to the settings tab of your repository

  1. On the left, find the tab titled “Collaborators”

  1. Click on “Add people” and enter the GitHub id or email address of the TAs Github IDs.

  1. Open the assignment on the LMS of your institution (Canvas, Brightspace), and enter the copied link into the corresponding textbox.

Notebooks#

If you have authored a notebook, using Colab or other cloud computational environments, the notebook can only be submitted as part of your Github repository and not as a separate file. Please do not share the notebook with your TA using the Share button.

In all cases, either local development or cloud development of notebooks: ensure that all cell outputs are saved before pushing the notebook to your github repo.

It is particularly important to avoid changing and pushing to Github the assignment after your submission date and until you receive a grade. If you do so, your TAs will flag the assignment as late.

Contents