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

Create readme.txt #196

Merged
merged 2 commits into from
Mar 6, 2020
Merged

Create readme.txt #196

merged 2 commits into from
Mar 6, 2020

Conversation

jeffpaul
Copy link
Member

@jeffpaul jeffpaul commented Mar 6, 2020

Description of the Change

This PR adds a readme.txt file, but not with ALL the details normally included for plugins distributed to WordPress.ORG mainly to avoid having to keep this in-sync with README.md though ensuring we display enough details through the plugin update checker as relevant for users in WP Admin.

Alternate Designs

n/a

Benefits

Ensures we display tested-up-to, requires-at-least, and description details in WP Admin.

Possible Drawbacks

None identified.

Verification Process

Manually verified via the GitHub web UI.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Applicable Issues

Closes #194

Changelog Entry

n/a

@jeffpaul jeffpaul added the needs:documentation This requires documentation. label Mar 6, 2020
@jeffpaul jeffpaul added this to the 1.5.1 milestone Mar 6, 2020
@jeffpaul jeffpaul requested a review from helen March 6, 2020 18:09
@jeffpaul jeffpaul self-assigned this Mar 6, 2020
@jeffpaul jeffpaul mentioned this pull request Mar 6, 2020
17 tasks
@helen helen merged commit c8dde0e into develop Mar 6, 2020
@helen helen deleted the add/readme-txt branch March 6, 2020 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:documentation This requires documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add readme.txt file
2 participants