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

misc: add links section to PR template #7266

Merged
merged 4 commits into from
Apr 29, 2022
Merged

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Apr 29, 2022

This is really helpful in PR to have links to:

  • all docs pages
  • all dogfood tests

This saves me a ton of time, and when it's not done, I generally do this even just for myself.

Sometimes it takes a long time to read diff, find relevant doc changes, infer URLs mentally and navigate to relevant doc pages, and a doc page may require multiple reviews before merging so it's really a time saver to include links ahead of time.

@slorber slorber added the pr: maintenance This PR does not produce any behavior differences to end users when upgrading. label Apr 29, 2022
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 29, 2022
@netlify
Copy link

netlify bot commented Apr 29, 2022

[V2]

Name Link
🔨 Latest commit 431d082
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/626bee93dff21500089e7d4b
😎 Deploy Preview https://deploy-preview-7266--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

What about this:

## Test plan

Deploy preview: https://deploy-preview-___--docusaurus-2.netlify.app/

## Related issues/PRs

<!-- ... -->

Also, I'd suggest use fewer emojis...

@github-actions
Copy link

github-actions bot commented Apr 29, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 65
🟢 Accessibility 100
🟠 Best practices 83
🟢 SEO 100
🟢 PWA 90

Lighthouse ran on https://deploy-preview-7266--docusaurus-2.netlify.app/

@netlify
Copy link

netlify bot commented Apr 29, 2022

[V2]

Name Link
🔨 Latest commit 3d025ad
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/626c0c034a90a100095ce893
😎 Deploy Preview https://deploy-preview-7266--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Apr 29, 2022

Size Change: 0 B

Total Size: 803 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 50.1 kB
website/build/assets/css/styles.********.css 107 kB
website/build/assets/js/main.********.js 607 kB
website/build/index.html 38.8 kB

compressed-size-action

@Josh-Cena
Copy link
Collaborator

Also, a problem I personally have with deploy preview links is that they are only available after you have sent the PR, so you almost always send the PR with that left blank. Quite inconvenient.

@slorber
Copy link
Collaborator Author

slorber commented Apr 29, 2022

Also, I'd suggest use fewer emojis...

I don't know, looks fine to me, and drive user attention to some text that would otherwise not be read

Also, a problem I personally have with deploy preview links is that they are only available after you have sent the PR, so you almost always send the PR with that left blank. Quite inconvenient.

will add a mention for that

@Josh-Cena
Copy link
Collaborator

We can also have a pre-flight checklist, if you want it to be more visible. Either is fine for me

@slorber
Copy link
Collaborator Author

slorber commented Apr 29, 2022

open to any suggestion, as long as it's visible enough :) feel free to edit

@Josh-Cena Josh-Cena force-pushed the slorber/update-pr-template branch from faaf2a4 to 3d025ad Compare April 29, 2022 16:02
@Josh-Cena
Copy link
Collaborator

@slorber Made some edits. WDYT?

@slorber
Copy link
Collaborator Author

slorber commented Apr 29, 2022

seems good enough 👍

@slorber slorber merged commit fe286f1 into main Apr 29, 2022
@slorber slorber deleted the slorber/update-pr-template branch April 29, 2022 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: maintenance This PR does not produce any behavior differences to end users when upgrading.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants