clean commits
For Preparing a Git Repository for University Submission, the clean commits step needs a visible outcome. If you cannot describe success or failure, reduce that step further before continuing.
COMPUTER SCIENCE GUIDE
Preparing a Git Repository for University Submission
A Git submission should demonstrate that the repository can be reproduced from a clean state. The important points are meaningful changes, a useful README and removal of secrets or local machine files, not the largest possible number of commits.
PRACTICAL EXAMPLE
Before submission, clone the repository into a new folder or clean environment. Run the documented build and tests. This exposes missing files and local dependencies before the marker encounters them.
HOW TO USE THIS GUIDE
Apply it to your own module and one small example
Do not treat Preparing a Git Repository for University Submission as a rigid checklist. Pick the first point that is unclear in your own work, test it with one concrete example, and only then move on.
FOUR STEPS
A short process you can apply directly
check the README
For Preparing a Git Repository for University Submission, the check the README step needs a visible outcome. If you cannot describe success or failure, reduce that step further before continuing.
remove secrets
For Preparing a Git Repository for University Submission, the remove secrets step needs a visible outcome. If you cannot describe success or failure, reduce that step further before continuing.
run a clean build and tests
For Preparing a Git Repository for University Submission, the run a clean build and tests step needs a visible outcome. If you cannot describe success or failure, reduce that step further before continuing.
COMMON MISTAKES
What makes the work harder than it needs to be
files exist only locally and were never committed
API keys or passwords remain in repository history
the README documents an outdated launch command
the build works only because packages are installed globally
SELF CHECK
Can you explain the process without the guide?
Close Preparing a Git Repository for University Submission and explain your next step in your own words. State the assumption, expected result and the test you will use for that specific step.
goal clearsmall exampleverifiable resultnext step known