While evaluating this module, I noticed it lacked a readme.
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...

CommentFileSizeAuthor
#7 image_field_tokens_d8-README-3004624-4.patch1.96 KBvolkswagenchick
#3 image_field_tokens_d8-3004624-1.patch937 bytesIreneV

Comments

volkswagenchick created an issue. See original summary.

IreneV’s picture

IreneV commented
Assigned: Unassigned » IreneV
IreneV’s picture

IreneV commented
Status: Active » Needs review
StatusFileSize
new image_field_tokens_d8-3004624-1.patch937 bytes
ysamoylenko’s picture

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

Great work. Thank you!

  • ysamoylenko committed eed17af on 8.x-1.x authored by IreneV 
    Issue #3004624 by IreneV, volkswagenchick, ysamoylenko: README missing
ysamoylenko’s picture

ysamoylenko commented
Status: Reviewed & tested by the community » Fixed

The patch was committed.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: IreneV » Unassigned
StatusFileSize
new image_field_tokens_d8-README-3004624-4.patch1.96 KB

I see that this was just committed - i did have some minor nitpicks :)
Great start for this readme! Thanks.

The readme doesn't quite follow Drupal documentation standards.
Here is a summary of the preferred format for READMEs:

Headings in all caps.
Headings underlined with ===/--- to the length of the heading, followed by a newline.
Two lines prior to headings (except the first one).
Bullets denoted by asterisks (*) with hanging indents.
Numbered lists indented 4 spaces.
Bulleted lists indented 1 space.
Text manually word-wrapped within around 80 cols.

ALSO

+++ b/README.txt
@@ -1 +1,30 @@
+- Image (included in Drupal 8 Core)
+- Tockens  (https://www.drupal.org/project/token)

Image is in core, so does not need to be included

Tokens is spelled incorrectly
Tockens => Token

I took the time to adds some additional configurations to the patch and reformatted according to best practices. Welcome to feedback!!

Status: Fixed » Closed (fixed)

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