Closed (fixed)
Project:
Token
Version:
7.x-1.x-dev
Component:
Code
Priority:
Normal
Category:
Task
Assigned:
Reporter:
Created:
26 Jan 2014 at 19:22 UTC
Updated:
3 Jul 2014 at 23:50 UTC
Jump to comment: Most recent, Most recent file
The README.txt seems a little short. It could be longer to comply with Drupal core standards.
| Comment | File | Size | Author |
|---|---|---|---|
| #4 | improving-readme_2182229_4.patch | 901 bytes | davidneedham |
| #1 | improving-readme_2182229_1.patch | 1.13 KB | davidneedham |
Comments
Comment #1
davidneedhamHere's a patch that adds extra information to the README.txt file.
Comment #2
wylbur commentedInstalled the patch to the dev version of the module on a clean D7 site.
The patch applied cleanly, and converts the README.txt file to be informative and complete.
Comment #3
dave reidShould we just remove the README.txt file? I don't think that this provides any really useful information that is outside of "normal" things. Even the maintainers list includes people who haven't committed to the module in over three years or more.
Comment #4
davidneedham(Background: For sprint weekend I ran a brief primer on creating and submitting patches. We used README files as an example because they're easy to step into for any skill level and you can clearly read the diff. I saw that the Token module's README.txt didn't conform to core standards for README files, so we walked through improving it.)
It's minor, but I do feel that every module should have an accurate README file so that:
In regards to official current maintainers, that's up to you. Even with the date last committed, d.o makes it difficult to see who might still be active in other capacities.
I created another patch that removes the TOC (since there's so little here), removes all other maintainers, conforms to 80 col line breaks, and provides the D7 module installation instructions (rather than the D5/D6 instructions).
Comment #6
dave reidCommitted to 7.x-1.x. Sorry I forgot to assign Git attribution. :/