Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.While evaluating this module, while it has a readme, - I noticed the readme could use some helpful links and configurations. Also, the formatting does not align to Drupal standards for documentation. There should be a clear table of contents and lines should be hard wrapped at 80 characters for better accessibility.
According to Drupal standards, modules should include a useful READMEmd .file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
Patch to follow, thanks!
| Comment | File | Size | Author |
|---|---|---|---|
| #7 | interdiff-3068818-2_7.txt | 7.31 KB | Webbeh |
| #7 | 3068818-7.patch | 1.75 KB | Webbeh |
| #2 | bridtv-README-3068818-2.patch | 4.51 KB | alonaoneill |
Comments
Comment #2
alonaoneill commentedComment #3
Willtg commentedReviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good. Patch applied with STM.
Marking as RTBC.
Thank you for working on the module!
Comment #4
damienmckennaThe patch changes the README from a Markdown file to a plain text with Drupal's conventions, loosing the benefits of using Markdown but confusing matters as the file is still named ".md" instead of being renamed to ".txt". I recommend either renaming the file to "README.txt" or improving the text of the existing document and retaining its Markdown syntax.
Comment #5
alonaoneill commentedThis patch has README.md as a Markdown file. It doesn't need any changes to .txt
Comment #6
damienmckennaYou followed the Drupal readme template which should be a plain text file, not a markdown file. The file should be renamed to README.txt.
Comment #7
WebbehPer #6, converting to txt and fixing one or two minuscule issues.
I have mentioned this conversation as a question in the #documentation Drupal Slack channel to better understand markdown-specific standards and best-practices.
Comment #8
kavitha89 commentedMoving it to RTBC
Comment #9
damienmckenna@kavitha: Please don't upload screenshots of your terminal showing a directory tree, it just adds noise.
Before an issue can be marked RTBC the changes need to be reviewed, this wasn't done.
Furthermore the documentation team have finally agreed upon a template for using markdown syntax: https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
This means that the patch needs further work to make it adhere to the new standard, so I'm setting the status back to "needs work".
Comment #10
ressaI agree @DamienMcKenna. See also #3315968-22: Replace README.txt with README.md where another RTBC was based on the patch applying, and no review of format or content.
Comment #11
gislekavitha@specbee.com: Please don't upload screenshots of your terminal showing a directory tree, it just adds noise to the issue.
Before an issue can be marked RTBC the changes need to be reviewed, this wasn't done.
Please read up on Issue Etiquette. Pay attention on #11 and #14 on the "Don't" list.
Your comment here is spam.