Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
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 README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Patch to follow, thanks!
Comment | File | Size | Author |
---|---|---|---|
#2 | context-README-3007934-2.patch | 3.93 KB | volkswagenchick |
Comments
Comment #2
volkswagenchickI uploaded a patch the updates the existing readme to include some useful links and reformats it to align to Drupal documentation standards (helps with readability)
Thanks!!
Comment #3
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedReviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good. Patch applied.
Marking as RTBCed.
Thank you for working on module!
Comment #4
boshtian CreditAttribution: boshtian at Agiledrop - Your Trusted Drupal Teammates commentedThanks for the updates. It definitely looks nicer.
Comment #6
boshtian CreditAttribution: boshtian at Agiledrop - Your Trusted Drupal Teammates commented