Skip to content

Add code review checklists#16447

Closed
stephaniehobson wants to merge 4 commits intomainfrom
checklists
Closed

Add code review checklists#16447
stephaniehobson wants to merge 4 commits intomainfrom
checklists

Conversation

@stephaniehobson
Copy link
Contributor

@stephaniehobson stephaniehobson commented Jul 24, 2025

One-line summary

Add code review checklists

Significant changes and points to review

The idea is to create a GitHub action which will post appropriate checklists in a comment when a pull request is opened if some file types have been touched. So, these are a little general in places. But, I'm hoping they can help keep our code base consistent-ish as we have more new developers contributing.

  • Add checklists for:
    • General
    • HTML
    • CSS
    • JS
    • Media
    • Analytics
    • Experiments
    • Localization
    • Tests
  • Some markdown clean up

Issue / Bugzilla link

n/a

Testing

@stephaniehobson stephaniehobson changed the title Add code review checklists to docs Add code review checklists Jul 29, 2025
uses: actions/checkout@v4

- name: Set up GitHub CLI
uses: cli/cli-action@v1
Copy link
Contributor

Choose a reason for hiding this comment

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

IIRC we don't need to add the cli explicitly - the gh cli is available in all workflows run on github-hosted runners.

@codecov
Copy link

codecov bot commented Jul 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.90%. Comparing base (b0478b6) to head (9b97ec9).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16447      +/-   ##
==========================================
- Coverage   79.91%   79.90%   -0.01%     
==========================================
  Files         158      158              
  Lines        8538     8531       -7     
==========================================
- Hits         6823     6817       -6     
+ Misses       1715     1714       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@stephaniehobson stephaniehobson force-pushed the checklists branch 2 times, most recently from 6b6c6d2 to 150b58c Compare July 29, 2025 21:07
@github-actions
Copy link

Thank you for your pull request. Based on the contents you may need to double-check these things:

No specific checklists needed for this PR.

@stevejalim
Copy link
Contributor

Thank you for your pull request. Based on the contents you may need to double-check these things:

No specific checklists needed for this PR.

@stephaniehobson If the bot can determine that no checklists are available, can it also swap the first line of that message to just say "Thank you for your pull request. Based on the contents, there is nothing to double-check [beyond the usual diligent review]" or similar?

@stephaniehobson
Copy link
Contributor Author

Superceded by #16460

@stephaniehobson
Copy link
Contributor Author

@stevejalim I changed it to not comment if nothing is found.

@stephaniehobson stephaniehobson deleted the checklists branch August 1, 2025 18:15
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