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!

CommentFileSizeAuthor
#2 epositivity-d8-README-3065485-2.patch2.65 KBalonaoneill

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

alonaoneill commented
Assigned: alonaoneill » Unassigned
Status: Active » Needs review
StatusFileSize
new epositivity-d8-README-3065485-2.patch2.65 KB
jqtnguyen’s picture

jqtnguyen commented
Status: Needs review » Reviewed & tested by the community

This README conforms to Drupal.org documentation standards at https://www.drupal.org/docs/develop/documenting-your-project/readme-temp.... Marking RTBC.

arturopanetta’s picture

arturopanetta
Primary language Italian
Location Grotteria (RC)
commented
arturopanetta’s picture

arturopanetta
Primary language Italian
Location Grotteria (RC)
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.