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: add before/after table #62739

Merged
merged 3 commits into from
Dec 2, 2024

Conversation

ellatrix
Copy link
Member

@ellatrix ellatrix commented Jun 21, 2024

What?

Adds a Before/After table to the PR template in the screenshot section.

Why?

  • I'm a bit tired of having to write out the table structure all the time.
  • People may not be aware that it's possible to use tables to display screenshots side-by-side.

How?

Adds a Markdown table skeleton.

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

@ellatrix ellatrix added the [Type] Project Management Meta-issues related to project management of Gutenberg label Jun 21, 2024
@ellatrix ellatrix requested a review from desrosj as a code owner June 21, 2024 11:54
Copy link

github-actions bot commented Jun 21, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: ellatrix <[email protected]>
Co-authored-by: t-hamano <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

If we go ahead with this PR, I feel a comment description may be necessary. One example is as follows. What do you think?

## Screenshots or screencast
<!-- If you would like to upload screenshots, please paste them in the table cells below, showing before and after this PR was applied. -->

|Before|After|
|-|-|
||| 

@ellatrix
Copy link
Member Author

Or:

|Before|After|
|-|-|
|<!-- Before screenshot here -->|<!-- After screenshot here -->|

@t-hamano
Copy link
Contributor

Personally, I think it would be easier to understand if there were both comments suggested by you and mine.

@t-hamano t-hamano force-pushed the try/pr-template-add-before-after-table branch from be16cdb to 55d0772 Compare November 30, 2024 10:21
@t-hamano t-hamano self-requested a review November 30, 2024 10:22
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

I've updated this PR according to this comment, and as I believe this PR still makes sense, I would like to approve it.

Copy link

Flaky tests detected in 9826fb8.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12095626471
📝 Reported issues:

@ellatrix ellatrix force-pushed the try/pr-template-add-before-after-table branch from 9826fb8 to 9a8f6c6 Compare December 2, 2024 10:22
@ellatrix
Copy link
Member Author

ellatrix commented Dec 2, 2024

Thanks @t-hamano, I've added a comment, also indicating that it's merely a suggestion and not a requirement when adding screenshots.

@ellatrix ellatrix enabled auto-merge (squash) December 2, 2024 10:23
@ellatrix ellatrix merged commit aef323a into trunk Dec 2, 2024
62 checks passed
@ellatrix ellatrix deleted the try/pr-template-add-before-after-table branch December 2, 2024 10:59
@github-actions github-actions bot added this to the Gutenberg 19.9 milestone Dec 2, 2024
im3dabasia pushed a commit to im3dabasia/gutenberg that referenced this pull request Dec 4, 2024
michalczaplinski pushed a commit that referenced this pull request Dec 5, 2024
Co-authored-by: ellatrix <[email protected]>
Co-authored-by: t-hamano <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Project Management Meta-issues related to project management of Gutenberg
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants