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!

CommentFileSizeAuthor
#4 interdiff-2980321-2-4.txt536 bytesvolkswagenchick
#4 csv_serialization-fix-readme-2980321-4.patch2.8 KBvolkswagenchick
#2 csv_serialization-fix-readme-2980321-2.patch2.8 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 csv_serialization-fix-readme-2980321-2.patch2.8 KB

i uploaded a patch that adds some useful information to the existing readme. Thanks!!

alonaoneill’s picture

alonaoneill commented
Status: Needs review » Needs work

Patch applied using simplytest.me. Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards.
Everything looks good, but: 

+++ b/README.md
@@ -1,11 +1,76 @@
+

"Two lines prior to headings (except the first one)."
And there are three.

Marking as "Needs work"
Thank!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs work » Needs review
StatusFileSize
new csv_serialization-fix-readme-2980321-4.patch2.8 KB
new interdiff-2980321-2-4.txt536 bytes

Thanks for the review. I uploaded a patch that addresses the extra line, as well as another extra line I found. Interdiff included for easy review.

Thanks!

alonaoneill’s picture

alonaoneill commented
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.

grasmash’s picture

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

Applied patch, made a few modifications, and committed.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

Thankyou for all the work you do!!
I am encouraging team mates to help out on Drupal.org, could you go back and give aAlona O'neill (alonaoneill) a credit for her review? She took the time to test and make sure everything was correct.
The box next to her name just gets ticked and she gets a credit! I see it as a way of incentive to help get involved it the community! It takes a village.

Cheers!

AmyJune - volkswagenchick

grasmash’s picture

grasmash commented

Unfortunately I'm not able to amend the commit given that the 8.x-1.4 tag has already been released, which contains the commit.

However, I made a whitespace change and attributed it to alonaoneill so that she will receive credit. Ticking the box in the "by" column doesn't actually change the commit author, but apparently Drupal.org registers the reference in the commit message anyway. See https://www.drupal.org/u/alonaoneill/issue-credits/2567011.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

Thanks! It takes a village!

Status: Fixed » Closed (fixed)

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