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

Revise readme.txt for new version #323

Merged
merged 5 commits into from
Nov 27, 2023
Merged

Conversation

felixarntz
Copy link
Member

@felixarntz felixarntz commented Nov 10, 2023

This PR revises the contents of readme.txt to better reflect the purpose and behavior of the new plugin version in trunk. It takes inspiration from the existing readme.txt from the legacy-plugin, as well as the existing README.md file from trunk.

Other than the readme.txt, a few related miscellaneous changes are included:

  • The README.md introduction is updated to use the same content as the new readme.txt.
  • The plugin short description is updated throughout to be consistent with the short description in readme.txt.
  • All tests plugins used for unit tests, which were previously using the old plugin description, have been updated to use a dummy description instead.

Fixes #300.

Copy link

codecov bot commented Nov 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (db28ffe) 39.49% compared to head (466e630) 39.49%.

Additional details and impacted files
@@           Coverage Diff           @@
##            trunk     #323   +/-   ##
=======================================
  Coverage   39.49%   39.49%           
=======================================
  Files          43       43           
  Lines        2028     2028           
=======================================
  Hits          801      801           
  Misses       1227     1227           
Flag Coverage Δ
feature 39.49% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
plugin-check.php 39.28% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@joemcgill joemcgill left a comment

Choose a reason for hiding this comment

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

@felixarntz I've left some editing feedback. Nothing that I think needs to be blocking, but could help with readability and consistency while we're thinking about it.

README.md Outdated Show resolved Hide resolved
composer.json Outdated Show resolved Hide resolved
plugin-check.php Outdated Show resolved Hide resolved
readme.txt Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
readme.txt Outdated Show resolved Hide resolved
readme.txt Outdated Show resolved Hide resolved
@felixarntz
Copy link
Member Author

Thanks @joemcgill, I've addressed your feedback. Could you please take another look?

@felixarntz felixarntz requested a review from joemcgill November 13, 2023 19:36
Copy link
Member

@joemcgill joemcgill left a comment

Choose a reason for hiding this comment

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

Thanks, @felixarntz!

@mukeshpanchal27 mukeshpanchal27 merged commit 0d76779 into trunk Nov 27, 2023
24 checks passed
@mukeshpanchal27 mukeshpanchal27 deleted the docs/300-revise-readme-txt branch November 27, 2023 04:07
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

Successfully merging this pull request may close these issues.

Update readme.txt contents to reflect the different use-cases and purposes of the plugin checker
5 participants