While evaluating this module, while it has a readme, I noticed the readme could use some helpful links and reformatting to align with Drupal documentation standards.
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!

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned
Status: Active » Needs review
StatusFileSize
new3.69 KB

I uploaded a patch that aligns the README to Drupal documentation standards and adds some useful links. Thanks!

alonaoneill’s picture

Status: Needs review » Reviewed & tested by the community

Patch applied using simplytest.me. Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. https://www.drupal.org/docs/develop/documenting-your-project/module-docu...
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Marking RTBC. Thanks for your work on a module.

  • volkswagenchick authored 9665172 on 8.x-1.x
    Issue #2980815 by volkswagenchick, alonaoneill: README configs and...
cmd87’s picture

Thanks guys! Patch applied.

cmd87’s picture

Status: Reviewed & tested by the community » Fixed
cmd87’s picture

Status: Fixed » Closed (fixed)