docs+ci: add PR packaging template + enforce it in CI#11
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
📝 HackYourFuture auto gradeAssignment Score: 48 / 100 ❌Status: ❌ Not passed Test Details |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What I built
Adds a package-complete PR template plus CI enforcement to this assignment repo.
.github/PULL_REQUEST_TEMPLATE.md: tailored to this week's deliverables, with sections What I built / How to review / How to run / What reviewers should see (expected results) / Known limitations / Self-check. Gives a reviewing mentor a package-complete, reproducible submission..github/workflows/pr-body-check.yml: fails a PR whose description is missing the required headings. GitHub only auto-injects the template in the web compose form /gh pr createwithout--body; a PR opened via the REST API or--body "..."(the path most AI tools take) skips it silently. This check closes that gap. Editing the PR description re-runs the check automatically (no new commit needed).How to review
Two added files (one edited on Week 11). Read the template top-to-bottom; the workflow greps case-insensitively for 5 headings.
How to run
No runtime. Verified locally: the filled template passes the check; an empty/free-form body fails and lists the missing headings.
What reviewers should see (expected results)
PR body check).Self-check
pull_request(notpull_request_target) withcontents: readonly🤖 Generated with Claude Code