WordPress.org

Making WordPress.org

Opened 2 weeks ago

Closed 2 weeks ago

#4942 closed defect (invalid)

Readme validator doesn't support GitHub web page of a readme.txt

Reported by: 1naveengiri Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords: 2nd-opinion close
Cc:

Description

Readme Validator showing unnecessary Errors and Warnings when GitHub branch readme file link is shared.

https://wordpress.org/plugins/developers/readme-validator/

Change History (6)

#1 @SergeyBiryukov
2 weeks ago

  • Component changed from General to Plugin Directory

#2 @ocean90
2 weeks ago

  • Keywords reporter-feedback added

What is a "GitHub branch readme file link"?

#3 @1naveengiri
2 weeks ago

by "Github branch readme file link"
https://github.com/woocommerce/woocommerce/blob/master/readme.txt

I know it throwing error because here entire Github page is being scrapped.

can we do anything for it so anyone can validate readme just by passing Github code file link?

#4 @ocean90
2 weeks ago

  • Keywords reporter-feedback removed
  • Summary changed from Readme validator not working properly to Readme validator doesn't support GitHub web page of a readme.txt

Not sure if it's worth it since it's easy to get the link to the raw file by clicking or copying the link from the "Raw" button.

#5 @dd32
2 weeks ago

  • Keywords 2nd-opinion close added

What about a Gitlab or Bitbucket url? What about another code hosting platform?

I think it's reasonable to expect that a user of such platforms can figure out how to copy a direct url to the file rather than a HTML preview of it.

#6 @Otto42
2 weeks ago

  • Resolution set to invalid
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.