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.

Sign up for GitHub

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

Jump to bottom

Modify Plugin Checker to only check root directory readme files #241

Merged
merged 5 commits into from
Aug 4, 2023
Merged

Modify Plugin Checker to only check root directory readme files #241

merged 5 commits into from
Aug 4, 2023

Conversation

mukeshpanchal27
Copy link
Member

Closes #240

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@mukeshpanchal27 mukeshpanchal27 marked this pull request as ready for review August 3, 2023 05:57
@mukeshpanchal27
Copy link
Member Author

One thing I encountered while working on this PR is whether any plugins have both readme.txt and readme.md files. If they do, should we display an error for both files?

felixarntz
felixarntz reviewed Aug 3, 2023
View reviewed changes
Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mukeshpanchal27, LGTM. Just one recommendation.

includes/Checker/Checks/Plugin_Readme_Check.php Outdated Show resolved Hide resolved
@felixarntz
Copy link
Member

@mukeshpanchal27

One thing I encountered while working on this PR is whether any plugins have both readme.txt and readme.md files. If they do, should we display an error for both files?

I don't think we need to flag this. A plugin may contain a readme.md file for GitHub, which is not a problem. However, what I would suggest is that, if there is a readme.txt, we should ignore the readme.md - since the readme.txt is the typical place and only has that purpose, while readme.md could be either for wordpress.org readme, or GitHub.

felixarntz
felixarntz requested changes Aug 3, 2023
View reviewed changes
Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, there is one issue that I found here with the implementation.

includes/Checker/Checks/Plugin_Readme_Check.php Outdated Show resolved Hide resolved
felixarntz
felixarntz approved these changes Aug 4, 2023
View reviewed changes
Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mukeshpanchal27, LGTM!

@felixarntz felixarntz merged commit e28d7f1 into trunk Aug 4, 2023
@felixarntz felixarntz deleted the fix/240-readme-issue branch August 4, 2023 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixarntz felixarntz felixarntz approved these changes

@swissspidy swissspidy swissspidy approved these changes

@joemcgill joemcgill Awaiting requested review from joemcgill

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Modify Plugin Checker to only check root directory readme files
3 participants
@mukeshpanchal27 @felixarntz @swissspidy