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

I uploaded a patch that adds a useful readme as per documentation standards, thanks!!

CommentFileSizeAuthor
#4 particle_responsive-readme-3013284-4.patch2.82 KBvolkswagenchick
#4 interdiff-3013284-2-4.txt390 bytesvolkswagenchick
#2 particle_responsive-readme-3013284-2.patch2.82 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 particle_responsive-readme-3013284-2.patch2.82 KB

I uploaded a patch that aligns the current readme to Drupal documentation standards. Thanks!!

alonaoneill’s picture

alonaoneill commented
Status: Needs review » Needs work

Looks good, patch applied, but I found

+++ b/README.txt
@@ -1,32 +1,71 @@
+ * In built Font Awesome ¶

An extra space.
Marking needs work.
Thanks

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs work » Needs review
StatusFileSize
new interdiff-3013284-2-4.txt390 bytes
new particle_responsive-readme-3013284-4.patch2.82 KB

Let's try again. Included an interdiff for easy review.

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!

swatichouhan012’s picture

swatichouhan012 commented

@volkswagenchick @alonaoneill Thanks for apply patch fixed issue.

swatichouhan012’s picture

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

Status: Fixed » Closed (fixed)

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