WordPress / WordPress/theme-check
The readme.txt file check is not specific enough
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 371
- Forks
- 113
- Avg merge
- 8m
- Merged PRs (30d)
- 5
Description
The readme.txt file check is intended to check if there is a readme.txt file that has information about the theme, but it will look for any readme.txt file.
If the themes readme.txt file is missing, but there is a third-party readme.txt file for a library inside a subfolder, the check passes.
Example theme:
https://themes.trac.wordpress.org/ticket/102187
The readme.txt file is inside https://themes.svn.wordpress.org/momentog/1.0/genericons/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the readme.txt file check in the theme-check plugin and reproduce the behavior with the linked example theme. The check is done when a third-party readme.txt in a subfolder no longer satisfies the check and the theme's own readme.txt is required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100