Skip to main content
Reviewing & Validating

The Review & Edit screen

Review starter, solution, tests, and student instructions. Approve the current package, run quality validation, then continue to Deploy.

Written By Alan Gandy

Last updated About 2 hours ago

After generation, open Review & Edit and inspect the four artifacts before allowing CodeTeach to build the GitHub repository.

Review the package

  • Starter: the code students receive. Check TODOs, file paths, signatures, and how it runs.

  • Solution: the instructor answer. Run through representative inputs and check that it implements the intended assignment.

  • Tests: inputs, observed expected outputs, comparison mode, and points. Add boundary cases and correct any mistaken grading behavior.

  • Instructions: student-facing Instructions.md. Confirm examples, learning objectives, difficulty fit, and grading guidance.

Edits save in the browser. Changing a graded artifact invalidates earlier approval or validation as appropriate. Review the resulting package again, approve the instructions, and rerun quality validation.

Two separate checks

Review & Edit performs the pre-deployment quality check after instructor approval. During Deploy, CodeTeach constructs the workflow and grading metadata, requires a passing internal GitHub-style run, then watches the real GitHub Actions run after publication. A successful Review check is not a post-push pass.

Learn about the approval gate or edit your tests.