WordPress.org

Make WordPress Core

Opened 2 years ago

Closed 23 months ago

Last modified 19 months ago

#31814 closed enhancement (fixed)

Bundled themes: add README files to explain basic theme usage

Reported by: lancewillett Owned by: lancewillett
Milestone: 4.3 Priority: normal
Severity: normal Version:
Component: Bundled Theme Keywords: has-patch
Focuses: Cc:

Description

To match best practices and guidelines for themes in the WordPress.org directory, and to help people get the most of of these themes, we should add README files to each default theme.

The starting content should be based on the Theme Showcase pages from WordPress.com, such as Twenty Fifteen: http://theme.wordpress.com/themes/twentyfifteen/.

This came up in discussions at WordCamp London contributor day, with reference to each theme having a changelog file, see #31074.

Attachments (6)

31814-twentyfifteen.patch (6.0 KB) - added by mercime 2 years ago.
31814-twentyfourteen.patch (3.5 KB) - added by mercime 2 years ago.
31814-twentythirteen.patch (3.0 KB) - added by mercime 2 years ago.
31814-twentytwelve.patch (3.1 KB) - added by mercime 2 years ago.
31814-twentyeleven.patch (3.8 KB) - added by mercime 2 years ago.
31814-twentyten.patch (3.1 KB) - added by mercime 2 years ago.

Download all attachments as: .zip

Change History (25)

#1 @lancewillett
2 years ago

As noted by mercime in #31074 — we can avoid putting too much textual content into the readme file and instead link to relevant Codex pages. This allows for easier editing (without the need to update the theme itself) and for richer content that has images and links, not just plain text.

Last edited 2 years ago by lancewillett (previous) (diff)

#2 @mercime
2 years ago

  • Keywords has-patch added; needs-patch removed

First pass at readme.txt files of the Bundled Themes. Attached patches have the following sections in each file:

  • Header
  • Description
  • Installation
  • Copyright
  • Changelog

The Copyright section also addresses the proper licensing for Bundled themes in #31899

Last edited 2 years ago by mercime (previous) (diff)

#3 @lancewillett
23 months ago

In 32487:

Twenty Fifteen: update readme file.

Props mercime, lancewillett. See #31814.

#4 @lancewillett
23 months ago

In 32488:

Twenty Fourteen: add readme file to explain basic theme usage, link to changelog on Codex, and include license information.

See #31814, props mercime.

#5 @lancewillett
23 months ago

In 32489:

Twenty Thirteen: add readme file to explain basic theme usage, link to changelog on Codex, and include license information.

See #31814, props mercime.

#6 @lancewillett
23 months ago

In 32490:

Twenty Twelve: add readme file to explain basic theme usage, link to changelog on Codex, and include license information.

See #31814, props mercime.

#7 @lancewillett
23 months ago

In 32491:

Twenty Eleven: add readme file to explain basic theme usage, link to changelog on Codex, and include license information.

See #31814, props mercime.

#8 @lancewillett
23 months ago

  • Owner set to lancewillett
  • Resolution set to fixed
  • Status changed from new to closed

In 32492:

Twenty Ten: add readme file to explain basic theme usage, link to changelog on Codex, and include license information.

Closes #31814, props mercime.

#9 @lancewillett
23 months ago

In 32493:

Twenty Fifteen: fix typo in readme file, props obenland. Format the release dates as per other bundled themes readme.txt file format.

See #31814.

#10 follow-up: @TomasM
23 months ago

Is "Tags: " in Description of 2012 intentional?

Last edited 23 months ago by TomasM (previous) (diff)

#11 in reply to: ↑ 10 @lancewillett
23 months ago

Replying to TomasM:

Is "Tags: " in Description of 2012 intentional?

Nope! Typo. Good eye. Will fix.

#12 @lancewillett
23 months ago

In 32494:

Twenty Twelve: fix typo in readme.txt file.

See #31814, props TomasM.

#13 @SergeyBiryukov
23 months ago

  • Milestone changed from Future Release to 4.3

#14 @SergeyBiryukov
19 months ago

In 33795:

Twenty Ten: Correct license information in readme.txt.

props Otto42.
see #33590, #31814.

#15 @SergeyBiryukov
19 months ago

In 33796:

Twenty Eleven: Correct license information in readme.txt.

props Otto42.
see #33590, #31814.

#16 @SergeyBiryukov
19 months ago

In 33797:

Twenty Twelve: Correct license information in readme.txt.

props Otto42.
see #33590, #31814.

#17 @SergeyBiryukov
19 months ago

In 33798:

Twenty Thirteen: Correct license information in readme.txt.

props Otto42.
see #33590, #31814.

#18 @SergeyBiryukov
19 months ago

In 33799:

Twenty Fourteen: Correct license information in readme.txt.

props Otto42.
see #33590, #31814.

#19 @SergeyBiryukov
19 months ago

In 33800:

Twenty Fifteen: Correct license information in readme.txt.

props Otto42.
see #33590, #31814.

Note: See TracTickets for help on using tickets.