Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature-request] Validate other things in the readme #13

Open
jazzsequence opened this issue Jul 14, 2023 · 0 comments
Open

[feature-request] Validate other things in the readme #13

jazzsequence opened this issue Jul 14, 2023 · 0 comments

Comments

@jazzsequence
Copy link

jazzsequence commented Jul 14, 2023

If we're using this to validate WordPress plugin readme's generally, perhaps we should broaden the scope to validate other things.

Possible "other things" include:

  • does Tested up to exist? if so, we can assume this is a WordPress plugin readme
    • if it's a plugin readme file that includes that field, does it also include all the other fields that could/should be in a readme.txt (since we're assuming this is a mirror)?
  • does a CHANGELOG.md exist?
    • if not, does a changelog exist in the README.md?
  • does a readme.txt exist?
    • if so, does it include all the expected fields that could/should be included in a readme.txt?
    • does it include a changelog, install instructions and frequently asked questions?

This broadens the scope away from validate-readme-spacing and dips into the territory of validate-wordpress-readme instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant