Project Submission Instructions

(Return to homepage)

Quick Submit

  1. Fill out the included README file.
  2. Ensure that the run.bat or run.sh script successfully compiles and runs your code.
    Note that your project will be graded with an unmodified copy of the test suite (test) and any library dependencies (lib).
  3. Zip the top-level project directory, e.g. CSC-143-Project0/.
    Please do not zip an outside folder with the project folder contained inside.
  4. Upload the zip file to the corresponding Canvas assignment.
  5. Download the zip file uploaded, and run the test suite again (Step 2) to ensure your submission works as expected.

Detailed Instructions

First, fill out the project README included in the top-level project folder. Make sure to specify any bonus points for the project you are claiming (such as using Git) to receive credit. Your README should look like this when the Unix cat command (the Windows command is type) is invoked with it as an argument:

briancui@X1:/mnt/c/Users/brian/workspace/CSC-143-Project0$ cat README
Name: Brian Cui
Student ID: 123456789
Email: your.email@email.com
Hours Spent: 5
Bonus Points Claimed: +5 for git
Comments: I had fun. I hope you did too!
briancui@X1:/mnt/c/Users/brian/workspace/CSC-143-Project0$

All projects are submitted on Canvas as a zip file. zip the top-level project folder, such that when it is unzipped, the top-level project folder appears in the working directory. You don't have to use the Unix zip command; any GUI zip tool (i.e. 7-Zip) should work fine (in Windows, right click the CSC-143-Project* folder and select Send To > Compressed (zipped) folder).

briancui@X1:/mnt/c/Users/brian/workspace$ zip -r briancui_p0.zip CSC-143-Project0/
updating: CSC-143-Project0/ (stored 0%)
  adding: CSC-143-Project0/.git/ (stored 0%)
  adding: CSC-143-Project0/.git/branches/ (stored 0%)
  ...

briancui@X1:/mnt/c/Users/brian/workspace$ ls *.zip
briancui_p0.zip
# I already have an existing folder with the name CSC-143-Project0,
# so I'll rename it temporarily before unzipping. You can skip this step.
briancui@X1:/mnt/c/Users/brian/workspace$ mv CSC-143-Project0 CSC-143-Project0-mine 
briancui@X1:/mnt/c/Users/brian/workspace$ unzip briancui_p0.zip
Archive:  briancui_p0.zip
    creating: CSC-143-Project0/
    creating: CSC-143-Project0/.git/
    creating: CSC-143-Project0/.git/branches/
  extracting: CSC-143-Project0/.git/COMMIT_EDITMSG
  ...

briancui@X1:/mnt/c/Users/brian/workspace$ ls -a CSC-143-Project0
.  ..  CSC-143-Project0.iml  .git  .gitignore  .idea  out  README  src
briancui@X1:/mnt/c/Users/brian/workspace$

Your code must compile and run with the included run.bat or run.sh scripts to receive any credit. Partial credit is only awarded if the code will compile! You may modify the test directory for your project, but your project will be graded using an unmodified version of the test suite and run script.

briancui@X1:/mnt/c/Users/brian/workspace$ cd CSC-143-Project0
./  ../  CSC-143-Project0.iml*  .git/  .gitignore*  .idea/  out/  README*  src/
briancui@X1:/mnt/c/Users/brian/workspace/CSC-143-Project0$ cd src
./  ../  hello/  lib/  run.bat*  run.sh*  test/
briancui@X1:/mnt/c/Users/brian/workspace/CSC-143-Project0/src$ chmod +x run.sh
briancui@X1:/mnt/c/Users/brian/workspace/CSC-143-Project0/src$ ./run.sh
BEGIN PROJECT 0 EVALUATION
Total tests: 15
==========================

test.HelloTest [3/3]

test.RangeTest [12/12]

!!! ALL TESTS PASSED! GREAT JOB !!!
Tests Passed: [15 / 15]
Overall Project Score: 100%
briancui@X1:/mnt/c/Users/brian/workspace/CSC-143-Project0/src$

Note that your project grade is contingent on the correctness of your implementation. I reserve the right to deduct points if you are passing tests but have an incorrect or incomplete implementation (i.e. you can't just write methods that return exactly what the tests expect and nothing else).

When you're ready, submit your zip file on the Canvas assignment. Good luck!

Late/Incomplete Submission Policy

The class late/incomplete submission policy can be found here.

(Return to homepage)