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

readme.txt should be part of the GitHub version #6004

Closed
2 tasks
bobbingwide opened this issue Apr 5, 2018 · 5 comments · Fixed by #18828
Closed
2 tasks

readme.txt should be part of the GitHub version #6004

bobbingwide opened this issue Apr 5, 2018 · 5 comments · Fixed by #18828
Labels
[Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.

Comments

@bobbingwide
Copy link
Contributor

Issue Overview

For most WordPress plugins the readme.txt file contains a number of fields which can be read using get_plugin_data.
This file is not provided in the development version of the plugin obtained from GitHub.

So I can't use get_plugin_data() to obtain information about the plugin.

Particularly interested in being able to access

Requires at least: 4.9
Tested up to: 4.9.5

Additionally, there are some typos in the change log. e.g. Add visibile text.

It would be nice if this file was under version control in GitHub, as well as SVN.

Steps to Reproduce (for bugs)

  1. Clone the plugin locally
  2. Try to find the readme.txt file

Expected Behavior

readme.txt file should be present.

Current Behavior

It's not. And I don't appear to be able to build it.

Possible Solution

Deliver the file as part of the GitHub repo.

Screenshots / Video

Related Issues and/or PRs

Todos

  • Tests
  • Documentation
@bobbingwide
Copy link
Contributor Author

Ah! Looks like you can't get those values using get_plugin_data() anyway.

@danielbachhuber danielbachhuber added the [Status] Needs More Info Follow-up required in order to be actionable. label Apr 10, 2018
@danielbachhuber
Copy link
Member

@bobbingwide Seems like this doesn't need action now. Feel free to re-open if you think necessary.

@swissspidy swissspidy added [Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement. and removed [Status] Needs More Info Follow-up required in order to be actionable. labels Jul 22, 2019
@swissspidy
Copy link
Member

Adding the readme.txt to the repository would make it easier to make contributions to it. Otherwise it gets somewhat forgotten.

A current example is #16674, where a change to the readme is necessary.

@youknowriad
Copy link
Contributor

We'll have to tweak the release tool a bit if we move the readme to this repo but I wouldn't mind. Also, what about changelog.txt

@swissspidy
Copy link
Member

Yeah I figured as much.

Adding changelog.txt as well makes sense too I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants