Skip to content

fix(ci): clarify duplicate notices and improve beginner metadata guidance - #4357

Merged
LucasHT22 merged 14 commits into
hackclub:mainfrom
SSoggyTacoMan:clarify-duplicate-pr-guidance
Oct 15, 2026
Merged

LucasHT22 merged 14 commits into
hackclub:mainfrom
SSoggyTacoMan:clarify-duplicate-pr-guidance

Conversation

@SSoggyTacoMan

@SSoggyTacoMan SSoggyTacoMan commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Improves the tone and clarity of automated messages across review automation, duplicate detection, and the stale queue to be friendlier and more encouraging. Also renames the duplicate label to Multiple Submissions (maintaining backward compatibility for Potential Duplicate), clarifies that authors should ask a reviewer to reopen a closed PR, and dramatically improves metadata validation UX for beginners.

Messages Updated

1. Older PR Duplicate Notice (buildOlderNotice)

Multiple open PRs

Thanks for submitting! We noticed you have multiple open submission PRs (newer: #).

To keep reviews fair and fast for everyone, authors can only have one submission PR open at a time:

  • Same game? You do not need to open a new PR to update your game! Pushing commits or editing files in your existing PR updates it automatically. Usually your newer PR (#) has your latest changes, but please check which PR has your best version, keep that one, and close the other.
  • Different games? That is awesome, but our review team can only review one game per author at a time. Please choose which game you would like reviewed first, keep that PR open, and close the other. You can submit your next game once this one is merged!
  • Next steps: If no action is taken, this older PR will close automatically in 3 days so your newest PR can move forward. If you prefer to keep this older PR instead, please close #. If you need any help, feel free to ask in the #sprig channel on Slack!

2. Newer PR Warning (buildLatestWarning)

You have older open PRs (#) labeled "Multiple Submissions". To keep review times fast for everyone, please keep only one game submission open at a time. If these are for the same game, check which PR has your best version, keep that one, and close the others. If these are different games, please keep only the game you want reviewed first and close the others (you can submit your next game once this one merges). Older inactive duplicates will close automatically after 3 days.

3. Check Detail on Older PR (buildOlderCheckDetail)

You have multiple open submission PRs (newer: #). To keep reviews fair and fast, each author can only have one open submission at a time. If this is the same game, please keep the PR with your best version and close the other. If these are different games, choose the one you would like reviewed first and close the other. If no action is taken, this older PR will close automatically in 3 days.

4. Auto-Triage Validation Comments

  • Passed: "All automated checks passed! Your game is ready for a reviewer to playtest."
  • Needs fixes: "Thanks for submitting! There are just a few quick fixes needed before we can playtest your game."
  • Fixes action prompt: "@author: you can update your game right here (edit file) or push new commits. Once you do, these checks will rerun automatically! If you get stuck or have questions, ask in the #sprig channel on Slack or ping @LucasHT22 here."

5. Stale Queue Inactivity Messages

  • 7-day reminder: "Just checking in! This submission has been waiting for updates for 7 days. Whenever you have time, push your fixes so we can get your game reviewed. If there is no response after 14 days, the PR will close automatically, but you can always ask a reviewer to reopen it whenever you are ready!"
  • 14-day close: "Closing this submission for now since there has been no activity for 14 days. Whenever you want to return to it, push your fixes and ping a reviewer to reopen it. We would love to see your game in the gallery!"
  • Duplicate auto-close: "Closing this older submission so your newer PR (#) can move forward. If you would rather keep this game instead, close # and ask a reviewer to reopen this PR."
  • Maintainer 7-day ping: "This submission has been ready for maintainer review for 7 days. @maintainers, could one of you take a look?"
  • Reviewer 3-day unclaim: "Releasing review claim back to the queue because there has been no activity for 3 days."

6. Metadata Validation & Beginner Guidance

  • Consolidated missing header: If a game file has no metadata block at all, replaces 7 cascading error lines with a single clear check: "Missing comment header at the top of <file>. Sprig games require a /* ... */ comment block with game details at line 1."
  • Actionable field instructions: Replaces robotic assertion messages like "Metadata in <file> is missing or has empty @title:" with clear, constructive instructions with examples (e.g. "Add a title for your game (e.g. @title: My Game) to the comment header at the top of <file>.").
  • Suppressed redundant sub-checks: Only runs @tags parsing and @addedOn date checks if those fields are actually provided, preventing authors from getting double-failed on missing fields.
  • Copy-paste template in comment: When any metadata check fails, renders a [!TIP] block with a pre-filled snippet containing the author's handle, game title, and current date ready to copy and paste directly into line 1.
  • Kindly-worded advisory note: Reminds authors that the template was auto-generated to help them, and kindly encourages them to review and customize their title, description, and tags before committing.

@vercel

vercel Bot commented Oct 11, 2026

Copy link
Copy Markdown

@SSoggyTacoMan is attempting to deploy a commit to the Hack Club Team on Vercel.

A member of the Team first needs to authorize it.

@SSoggyTacoMan
SSoggyTacoMan marked this pull request as ready for review October 11, 2026 13:51

@LucasHT22 LucasHT22 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make nicer messages pls

@SSoggyTacoMan

SSoggyTacoMan commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor Author

yo i put the ping as u for the maintainer thingy since ur like the only rn doing it so well lmk if u want me to change it

@SSoggyTacoMan SSoggyTacoMan changed the title fix(ci): clarify duplicate submission guidance and notices fix(ci): clarify duplicate notices and improve beginner metadata guidance Oct 14, 2026

@LucasHT22 LucasHT22 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@LucasHT22
LucasHT22 added this pull request to the merge queue Oct 15, 2026
Merged via the queue into hackclub:main with commit a00cb35 Oct 15, 2026
7 of 8 checks passed
@SSoggyTacoMan
SSoggyTacoMan deleted the clarify-duplicate-pr-guidance branch October 15, 2026 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants