Skip to content

chore: add validation instructions to pr template#5506

Merged
bmuenzenmeyer merged 3 commits intonodejs:mainfrom
bmuenzenmeyer:main
Jul 17, 2023
Merged

chore: add validation instructions to pr template#5506
bmuenzenmeyer merged 3 commits intonodejs:mainfrom
bmuenzenmeyer:main

Conversation

@bmuenzenmeyer
Copy link
Copy Markdown
Contributor

Description

Pull requests like #5500 created confusion as to what the actual bug and fix were. Reviewers had to compare old and new version of the code to determine the efficacy of the change.

This PR updates our pull request template to add a new section, Validation. It provides brief guidance to the submitter as an HTML comment:

  • How do you know this is working?
  • What should a reviewer look for?
  • Provide a screenshot if your change is visual.

Related Issues

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run npx turbo lint to ensure the code follows the style guide. And run npx turbo lint:fix to fix the style errors if necessary.
  • I have run npx turbo format to ensure the code follows the style guide.
  • I have run npx turbo test to check if all tests are passing, and/or npx turbo test:snapshot to update snapshots if I created and/or updated React Components.
  • I've covered new added functionality with unit tests if necessary.

@bmuenzenmeyer bmuenzenmeyer requested a review from a team as a code owner July 13, 2023 03:34
@vercel
Copy link
Copy Markdown

vercel Bot commented Jul 13, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2023 0:41am
nodejs-org-stories ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2023 0:41am

@vercel vercel Bot temporarily deployed to Preview – nodejs-org-stories July 13, 2023 03:34 Inactive
@vercel vercel Bot temporarily deployed to Preview – nodejs-org July 13, 2023 03:35 Inactive
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 13, 2023

📦 Next.js Bundle Analysis for nodejs.org

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

Comment thread .github/PULL_REQUEST_TEMPLATE.md
@vercel vercel Bot temporarily deployed to Preview – nodejs-org-stories July 13, 2023 13:10 Inactive
@vercel vercel Bot temporarily deployed to Preview – nodejs-org July 13, 2023 13:11 Inactive
Copy link
Copy Markdown
Contributor

@HinataKah0 HinataKah0 left a comment

Choose a reason for hiding this comment

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

+1 on this for better workflow (although let's wait for other opinions as well).

A small nit is to rename it to Test Plan but let's see how other people think about it.
Thanks for bringing it up!

@vercel vercel Bot temporarily deployed to Preview – nodejs-org-stories July 15, 2023 01:55 Inactive
@bmuenzenmeyer

This comment was marked as resolved.

@vercel vercel Bot temporarily deployed to Preview – nodejs-org July 15, 2023 01:56 Inactive
@mikeesto

This comment was marked as resolved.

@vercel vercel Bot temporarily deployed to Preview – nodejs-org July 17, 2023 12:41 Inactive
@vercel vercel Bot temporarily deployed to Preview – nodejs-org-stories July 17, 2023 12:41 Inactive
@bmuenzenmeyer
Copy link
Copy Markdown
Contributor Author

lets go with this for now and see how it feels over time

@bmuenzenmeyer bmuenzenmeyer merged commit 526781f into nodejs:main Jul 17, 2023
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.

3 participants