WordPress.org

Make WordPress Core

Opened 3 months ago

Closed 3 months ago

Last modified 3 months ago

#49508 closed defect (bug) (invalid)

Edit Pull Request description

Reported by: isabel_brison Owned by:
Milestone: Priority: normal
Severity: normal Version: 5.4
Component: General Keywords:
Focuses: Cc:

Description

As part of the new GitHub Pull Request syncing to Trac functionality, PR descriptions are added to Trac tickets. However, the content of the description that appears on Trac includes the commented out sections that are meant for information only, which makes things very noisy and hard to read.

As a workaround, let's edit the description to include only the minimum essential info for contributors to successfully create a PR.

Change History (7)

This ticket was mentioned in PR #168 on WordPress/wordpress-develop by tellthemachines.


3 months ago

<!-- Insert a description of your changes here -->

Removes most of the boilerplate from the PR description field, so that the synced Trac comment won't be too noisy.
(I have manually deleted the boilerplate from this PR, so see 38009 for a sample of what it looks like currently)

Trac ticket: <!-- insert a link to the WordPress Trac ticket here -->
Fixes https://core.trac.wordpress.org/ticket/49508

---
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See [GitHub Pull Requests for Code Review](https://make.wordpress.org/core/handbook/contribute/git/github-pull-requests-for-code-review/) in the Core Handbook for more details.

#3 @swissspidy
3 months ago

  • Focuses docs removed
  • Milestone Awaiting Review deleted
  • Resolution set to invalid
  • Status changed from new to closed

Please open up tickets in Meta Trac for any issues that you find regarding Trac and the GitHub PR integration.

Core Trac is meant for tracking bugs in WordPress itself, not the systems around it.

Thanks!

#4 @isabel_brison
3 months ago

@swissspidy the change, as per the PR I linked to above, is to the core codebase, not to meta. As such I believe this is the appropriate place to create a ticket.

#5 @swissspidy
3 months ago

Wouldn't it make more sense to strip these HTML comments before submitting the comments here? The comments are really valuable for new contributors who might not know about the whole process.

#6 @ocean90
3 months ago

I agree that we don't need a workaround if HTML comments are stripped before posting to Trac. The related commit/ticket is [meta9531]/#meta5054.

Note: See TracTickets for help on using tickets.