#37998 closed enhancement (fixed)
readme.txt and readme.md
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Milestone: | 5.3 | Priority: | normal |
| Severity: | normal | Version: | 4.7 |
| Component: | Build/Test Tools | Keywords: | has-patch |
| Focuses: | docs | Cc: |
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)
Change History (16)
#1
@
8 years ago
- Component changed from General to Build/Test Tools
- Keywords good-first-bug needs-patch added
#2
@
8 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.
#4
@
8 years ago
- Keywords has-patch added; good-first-bug removed
- Milestone changed from Awaiting Review to Future Release
Related: #33043
#5
@
8 years ago
The red and green color coded block in the previous patch should be reversed.
A revised version was uploaded.
There's already readme.html in
/src, adding areadme.txtorreadme.mdonly duplicates the existing content and as GitHub already renders thereadme.htmlthis is sufficient.Adding
readme.mdto 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