Git and GitHub During the Assignment

Git and GitHub During the Assignment

Git and GitHub help you save versions of your work and keep a backup outside the current computer or CVD session.

They do not replace D2L Brightspace for assignment submission.

Three Different Things

It helps to distinguish:

• Local repository — the ~/Repos/it140-m3-assignment folder where you work in VS Code
• Personal GitHub repository — your private copy stored on GitHub
• Course template repository — GC-STEM/it140-m3-assignment, maintained by the course team

You edit your personal copy, not the course template.

Create Your Personal Repository Once

Follow the top-level repository README the first time you create and clone your personal M3 repository.

After it exists, reopen it instead of running the template-creation command again.

Save Files vs. Commit Files

Saving in VS Code writes changes to the local file.

A Git commit records a version of those changes in the repository history.

A push sends committed changes to your personal GitHub repository.

These are separate actions:

Save → Commit → Push

What Should Change?

The repository identifies the student-editable files:

• paycheck_calculator_sdw.md — optional notes
• design/paycheck_calculator.drawio — graded
• design/paycheck_calculator.pseudo — graded
• src/paycheck_calculator.py — optional practice

Course-managed README, SRS, SDD, test, CI, and configuration files should remain unchanged in a student repository.

Check Before Committing

From the repository root:

git status

Review the file list.

If you see a course-provided file you did not intend to edit, investigate before committing.

Command-Line Save Workflow

A typical command-line sequence is:

cd ~/Repos/it140-m3-assignment
git status
git add paycheck_calculator_sdw.md design/paycheck_calculator.drawio design/paycheck_calculator.pseudo src/paycheck_calculator.py
git commit -m "Save Module Three assignment progress"
git push

If Git says there is nothing to commit, there are no new saved changes for Git to record.

VS Code Source Control Workflow

You can perform the same basic actions through VS Code:

1. Open Source Control.
2. Review changed files.
3. Stage intended student-work files.
4. Enter a commit message.
5. Commit.
6. Sync/Push.

Use whichever method helps you understand what is happening.

GitHub Assignment Checks

After a push, GitHub Actions runs the repository's Assignment Checks.

A red X while you are still working may mean a graded file is still unchanged from the starter or pseudocode TODOs remain.

A green check means the automated repository checks passed. It does not mean:

• the design quality was graded;
• you earned a particular score;
• your instructor reviewed the work; or
• the assignment was submitted to D2L.

Returning Later

Open your existing local repository in VS Code and continue working.

Do not create another repository from the course template each time you return.

Working on Another Computer

If your personal repository has already been pushed to GitHub, clone that existing repository on the second computer:

cd ~/Repos
gh repo clone "$(gh api user --jq .login)/it140-m3-assignment"
cd it140-m3-assignment
git status

Do not create a second personal repository from the template.

Recovery

The repository README contains two recovery patterns:

• preserve the local folder and restore a fresh clone from your personal GitHub repository;
• preserve both the local and GitHub copies, then intentionally start over from the current course template.

Use the least destructive option that solves the problem.

Privacy

Keep your personal assignment repository private as directed by the course workflow.

Do not post completed graded solutions publicly when asking for help.

Assignment Submission

Even if everything is safely pushed to GitHub, you must still submit the two required files in D2L Brightspace:

• design/paycheck_calculator.drawio
• design/paycheck_calculator.pseudo

Remember:

GitHub = development and backup

D2L Brightspace = submission, grading, and instructor feedback

Return to Home or continue to Assignment Problems and Support.