PR template standardized #201
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,35 @@ | ||
| Issue: # | ||
|
|
||
| ## Summary | ||
|
|
||
| <!-- | ||
| 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 QA | ||
|
|
||
| <!-- | ||
| 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 | ||
|
|
||
| <!-- ignore-task-list-start --> | ||
|
|
||
| <!-- | ||
| ## Release checklist | ||
| - [ ] [Changeset](https://github.com/chromaui/chromatic-e2e/blob/main/DEVELOPMENT.md#pr-workflow-with-changesets) created in this PR | ||
|
|
||
| --> | ||
|
|
||
| <!-- ignore-task-list-end --> | ||
This file contains 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
| 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 }}' | ||
|
There was a problem hiding this comment. Don't forget to add this secret! There was a problem hiding this comment. I believe it's created for me: https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication |
||
| 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! | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we actually want this ignored? When would we not create a Changeset?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point! I'll have it commented-in with a note to remove if not publishing to NPM.