Skip to content

Update PULL_REQUEST_TEMPLATE.md #18423

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jun 24, 2022
Merged

Update PULL_REQUEST_TEMPLATE.md #18423

merged 5 commits into from
Jun 24, 2022

Conversation

cmwilson21
Copy link
Contributor

@cmwilson21 cmwilson21 commented Jun 3, 2022 •
edited
Loading

Why:

Closes #17811

What's being changed:

This is an overall refresh to the PR template while considering the concerns brought up in the issue linked above. The overall template has been slimmed down in general. More specifically:

  • Relative links have been removed as they are in HTML comments and are un-clickable. Because they are relative links, users cannot copy and paste the entirety of the address.
    • The contributing.md link was removed as it is linked under the PR box display.
    • Both translated content and site policy references were completely removed as there are not many of those. If these numbers increase after removal, we can add them back in again.

Other smaller updates were made to tighten up screen space and update to current wording in the preview section.

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@cmwilson21
Update PULL_REQUEST_TEMPLATE.md
4ab81ea 
updating some of the phrasing
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 3, 2022
@Ruslan786136

This comment was marked as spam.

Sign in to view
cmwilson21 added 3 commits June 6, 2022 16:15
@cmwilson21
Update PULL_REQUEST_TEMPLATE.md
c98d9e0 
first commit cleaning up the template a bit - added notes for further updates.
@cmwilson21
Update PULL_REQUEST_TEMPLATE.md
c3e7ed1 
removed line about site policy contributions and other small updates
@cmwilson21
Update PULL_REQUEST_TEMPLATE.md
b79367c 
cleaned up a bit more of the redundant language I accidentally created
@cmwilson21 cmwilson21 marked this pull request as ready for review June 8, 2022 15:32
@cmwilson21 cmwilson21 requested a review from a team as a code owner June 8, 2022 15:32
@rsese
Copy link
Member

rsese commented Jun 8, 2022

I think docs-eng was pinged for review because of CODEOWNERS but this seems like something more for @janiceilene?

I did take a peek though and 👍 on the update about the auto generated content comment -- wasn't changed to reflect updates so thanks for catching that!

@rsese rsese removed the request for review from a team June 8, 2022 17:48
@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jun 8, 2022
@cmwilson21
Copy link
Contributor Author

@rsese Sorry for the ping on the eng team, but thanks for taking a peek at it! I wish I could take the credit for noticing the auto generated comment, but that was from the issue creator. Then we decided the whole template could use a bit of an update. ✨

Thanks again for taking a look! 💖

@janiceilene janiceilene self-assigned this Jun 9, 2022
@janiceilene janiceilene self-requested a review June 9, 2022 17:30
janiceilene
janiceilene approved these changes Jun 10, 2022
View reviewed changes
Copy link
Contributor

@janiceilene janiceilene left a comment

Choose a reason for hiding this comment

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

This looks great! Thanks for making these updates :shipit:

@cmwilson21 cmwilson21 added ready to merge This pull request is ready to merge labels Jun 24, 2022
@cmwilson21 cmwilson21 merged commit 579d404 into main Jun 24, 2022
@cmwilson21 cmwilson21 deleted the pr-template-update branch June 24, 2022 19:44
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

ejgdfgidf
ejgdfgidf reviewed Jun 25, 2022
View reviewed changes
Copy link

@ejgdfgidf ejgdfgidf left a comment

Choose a reason for hiding this comment

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

@[](url)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ejgdfgidf ejgdfgidf ejgdfgidf left review comments

@janiceilene janiceilene janiceilene approved these changes

Assignees

@janiceilene janiceilene

Labels
content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PR template referencing things not present
5 participants
@cmwilson21 @Ruslan786136 @rsese @janiceilene @ejgdfgidf