[wp-trac] [WordPress Trac] #37998: readme.txt and readme.md

[WordPress Trac]

#37998: readme.txt and readme.md
----------------------------------------+------------------------------
 Reporter:  bhubbard                    |       Owner:
     Type:  enhancement                 |      Status:  new
 Priority:  normal                      |   Milestone:  Awaiting Review
Component:  Build/Test Tools            |     Version:  trunk
 Severity:  normal                      |  Resolution:
 Keywords:  good-first-bug needs-patch  |     Focuses:  docs
----------------------------------------+------------------------------

Comment (by stevenlinx):

 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, some of the PRs were closed not because
 the requests were 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.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/37998#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform