While evaluating this module, while it has a readme, I noticed the readme could use some helpful links and configurations and be reformatted to alig to 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...

FILE: /home/thallesvf/Desktop/lando/d8-contrib/modules/imce/README.txt
----------------------------------------------------------------------
FOUND 0 ERRORS AND 5 WARNINGS AFFECTING 5 LINES
----------------------------------------------------------------------
 23 | WARNING | Line exceeds 80 characters; contains 81 characters
 24 | WARNING | Line exceeds 80 characters; contains 96 characters
 35 | WARNING | Line exceeds 80 characters; contains 99 characters
 37 | WARNING | Line exceeds 80 characters; contains 102 characters
 38 | WARNING | Line exceeds 80 characters; contains 95 characters
----------------------------------------------------------------------

Patch to follow, thanks!

CommentFileSizeAuthor
#8 interdiff-2-8.txt567 bytesthalles
#8 imce-readme-3014274-8-D8.patch3.27 KBthalles
#7 interdiff-2-7.txt431 bytesthalles
#7 imce-readme-3014274-7-D8.patch3.27 KBthalles
#2 imce-readme-3014274-2.patch3.26 KBvolkswagenchick

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
Status: Active » Needs review
StatusFileSize
new imce-readme-3014274-2.patch3.26 KB

I uploaded a patch that better aligns the readme to Drupal documentation standards, thanks!

alonaoneill’s picture

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

Reviewed 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!

thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented

Can you show here the output of phpcs, before and after the changes?

thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented
Status: Reviewed & tested by the community » Postponed (maintainer needs more info)
thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented
Issue summary: View changes
thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented
Status: Postponed (maintainer needs more info) » Needs review
StatusFileSize
new imce-readme-3014274-7-D8.patch3.27 KB
new interdiff-2-7.txt431 bytes

Follow the patch!

thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented
StatusFileSize
new imce-readme-3014274-8-D8.patch3.27 KB
new interdiff-2-8.txt567 bytes

Follow a new patch!

  • thalles committed 371c1c3 on 8.x-1.x 
    Issue #3014274 by thalles, volkswagenchick, alonaoneill: README configs...
thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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