Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR template standardized #201

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
32 changes: 28 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,33 @@
Issue: #

## What Changed
## Summary

<!-- Insert a description below. -->
<!--
Describe the changes made.
What would someone unfamiliar with the project (but familiar with the codebase) need to understand what happened and why?
-->

## How to test
## How to QA

<!-- Add an explanation below for the reviewers to help them test your changes. -->
<!--
Provide step-by-step instructions on how to verify the work.
Use the canary build of the e2e packages (created via the `release_canary` CI job with this PR)
If necessary, include details on how to test in production.

Don't forget to test related features!
-->

1.

Check ☑️ the appropriate box once you've finished QA:

- [ ] Author - QA OK
- [ ] Reviewer - QA OK

## Release checklist

<!--
If you're not publishing the packages to NPM, delete this section.
-->

- [ ] [Changeset](https://github.com/chromaui/chromatic-e2e/blob/main/DEVELOPMENT.md#pr-workflow-with-changesets) created in this PR
29 changes: 29 additions & 0 deletions .github/workflows/checklist.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Checking PR checklist
permissions: read-all
on:
pull_request:
types: [opened, edited, synchronize]

jobs:
check-pr-description:
runs-on: ubuntu-latest
steps:
- id: task-completed
uses: chromaui/task-completed-checker-action@main
with:
repo-token: '${{ secrets.GITHUB_TOKEN }}'
Copy link
Member

Choose a reason for hiding this comment

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

Don't forget to add this secret!

Copy link
Member Author

Choose a reason for hiding this comment

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

continue-on-error: true
- name: Update Check (failure)
if: steps.task-completed.outcome != 'success'
uses: ouzi-dev/commit-status-updater@v2
with:
name: PR Checklist
status: pending
description: Check off PR items to proceed
- name: Update Check (success)
if: steps.task-completed.outcome == 'success'
uses: ouzi-dev/commit-status-updater@v2
with:
name: PR Checklist
status: success
description: All tasks checked off!
Loading