WordPress.org

Make WordPress Core

Opened 4 years ago

Closed 4 years ago

#40591 closed defect (bug) (wontfix)

Stop Encouraging Modified Markdown for Plugins

Reported by: jhabdas Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: Plugins Keywords:
Focuses: Cc:

Description

https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#markdown

The current standards for creating TXT files with modified markdown is silly and they look terrible when people drop into OSS repos on GitHub. Right now I'm having two manage a separate README file s because I don't want individuals to have a bad experience when they land on my plugin when searching through Git or another DCVS.

Please fix this. We need markdown file support and standardization. And please deprecate modified Markdown. Doing that (and not even linking to a spec, as shown in the developer docs above) seems downright senseless to me in 2017.

Change History (1)

#1 @ocean90
4 years ago

  • Milestone Awaiting Review deleted
  • Resolution set to wontfix
  • Status changed from new to closed
  • Version trunk deleted

Thanks for your suggestion but there's currently no plan for deprecating the current readme format. Please note that this isn't really the best place to discuss this.

Feel free to join our Slack team and the #pluginreview channel so you can get some more details on why we're using this format or to discuss any improvements.

Note: See TracTickets for help on using tickets.