WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 2 months ago

Last modified 2 months ago

#37998 closed enhancement (fixed)

readme.txt and readme.md

Reported by: bhubbard Owned by:
Milestone: 5.3 Priority: normal
Severity: normal Version: 4.7
Component: Build/Test Tools Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description

I checked for ticket but couldn't find one, it would be great to have a readme.md version for the github version of WordPress. There are several pull-requests attempt for it.

https://github.com/WordPress/WordPress/pull/200
https://github.com/WordPress/WordPress/pull/222

Attachments (3)

readme.md (6.1 KB) - added by stevenlinx 3 years ago.
37998.patch (6.2 KB) - added by stevenlinx 3 years ago.
37998.2.patch (6.2 KB) - added by stevenlinx 3 years ago.

Download all attachments as: .zip

Change History (16)

#1 @netweb
3 years ago

  • Component changed from General to Build/Test Tools
  • Keywords good-first-bug needs-patch added

There's already readme.html in /src, adding a readme.txt or readme.md only duplicates the existing content and as GitHub already renders the readme.html this is sufficient.

Adding readme.md to the root of the develop repo though I do think makes sense, as seen on our defacto GitHub develop repo there is no readme shown at https://github.com/aaronjorbin/develop.wordpress

@stevenlinx
3 years ago

#2 @stevenlinx
3 years ago

1.)

There were multiple PRs requesting to include readme.md for the "WordPress/WordPress" repository. So far, there are 11 PRs on this issue.

https://github.com/WordPress/WordPress/pulls?utf8=%E2%9C%93&q=readme.md

If you read through each of them, all of the PRs that were closed are not due to the requests being invalid/rejected, but because a8c doesn't accept PRs on GitHub.

2.)

I personally don't think it's a bad thing to include a tiny readme.md file in the source, even if this is primary for GitHub. But, also, I wonder if there are people who would prefer to read the Markdown format than the HTML format?

Many people access the "WordPress/WordPress" repo on GitHub, but the repo looks ugly when the first page is rendered as raw html.

The raw html page can make people question if they have landed on the official repository page.

Last edited 3 years ago by stevenlinx (previous) (diff)

#3 @stevenlinx
3 years ago

  • Keywords needs-patch removed

#4 @netweb
3 years ago

  • Keywords has-patch added; good-first-bug removed
  • Milestone changed from Awaiting Review to Future Release

Related: #33043

@stevenlinx
3 years ago

@stevenlinx
3 years ago

#5 @stevenlinx
3 years ago

The red and green color coded block in the previous patch should be reversed.

A revised version was uploaded.

#6 @SergeyBiryukov
19 months ago

#43595 was marked as a duplicate.

#7 @swissspidy
10 months ago

#45578 was marked as a duplicate.

#8 @SergeyBiryukov
10 months ago

#45590 was marked as a duplicate.

#9 @dd32
10 months ago

#45751 was marked as a duplicate.

This ticket was mentioned in Slack in #core by netweb. View the logs.


4 months ago

#12 follow-up: @noisysocks
2 months ago

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

[45745] included a README.md file.

Last edited 2 months ago by noisysocks (previous) (diff)

#13 in reply to: ↑ 12 @netweb
2 months ago

  • Milestone changed from Future Release to 5.3

Replying to noisysocks:

[45745] included a README.md file.

👌🏼

Note: See TracTickets for help on using tickets.