WordPress.org
Get WordPress

Make WordPress Core

Opened 6 years ago

Closed 5 years ago

#45871 closed enhancement (fixed)

Validate readme file content

Reported by: rabmalin's profile rabmalin Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 5.2 Priority: normal
Severity: normal Version:
Component: Bundled Theme Keywords: has-patch
Focuses: Cc:

Description

From the Theme Review meeting in 23 October 2018, it is now required to validate the content of readme file similar to plugins.
Meeting notes - ​https://make.wordpress.org/themes/2018/10/25/october-23rd-theme-review-team-meeting-summary/

Guidelines - ​https://make.wordpress.org/themes/handbook/review/required/#readme-txt-file

Validator - ​https://wordpress.org/plugins/developers/readme-validator/

Attachments (1)

45871.patch​ (5.0 KB) - added by SergeyBiryukov 5 years ago.

Download all attachments as: .zip

Change History (7)

This ticket was mentioned in ​Slack in #themereview by rabmalin. ​View the logs.
6 years ago

This ticket was mentioned in ​Slack in #core-themes by rabmalin. ​View the logs.
6 years ago

@SergeyBiryukov
5 years ago

#3 @SergeyBiryukov
5 years ago

  • Keywords has-patch added
  • Milestone changed from Awaiting Review to 5.2

Hi @rabmalin, thanks for the ticket! Bumping this to 5.2 per the ​Slack discussion.

When checking the bundled theme readmes with the ​validator, I see two warnings:

  • The Requires PHP field is missing.
  • One or more contributors listed were ignored. The Contributors field should only contain WordPress.org usernames. Remember that usernames are case-sensitive.

I've uploaded a patch fixing these warnings. Would that be enough to make the readmes compatible with the theme guidelines? Is there anything else?

#4 @SergeyBiryukov
5 years ago

  • Owner set to SergeyBiryukov
  • Status changed from new to accepted

#5 @rabmalin
5 years ago

I've uploaded a patch fixing these warnings. Would that be enough to make the readmes compatible with the theme guidelines? Is there anything else?

Yes. Currently we are requiring upto Warnings in readme. Notes (which are recommended) could be fixed when theme readme is fully implemented like plugin in the future.

#6 @SergeyBiryukov
5 years ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 45250:

Bundled Themes: Update readme.txt files to pass Theme Review guidelines.

Props rabmalin.
Fixes #45871.

Note: See TracTickets for help on using tickets.