While evaluating this module, while it has a readme, I noticed the readme could use some helpful 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
#5 captcha-README-3006824-5.patch4.38 KBvolkswagenchick
#3 captcha-d8-README-3006824-3.patch4.38 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

I have uploaded a patch that adds some useful links and configurations to the existing readme, I also took the time to re-format to better align with Drupal documentations standards.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
StatusFileSize
new captcha-d8-README-3006824-3.patch4.38 KB

ooops - here's the patch

alonaoneill’s picture

alonaoneill commented
Status: Needs review » Needs work

Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good, but patch did find a mistake

+++ b/README.md
@@ -1,64 +1,85 @@
+Supporting organizations: ¶

an extra space

Marking as Need work.
Thank you for working on module!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs work » Needs review
StatusFileSize
new captcha-README-3006824-5.patch4.38 KB

Let's try this again.

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!

wundo’s picture

wundo commented
wundo’s picture

wundo commented

  • wundo committed 0941dc7 on 8.x-1.x authored by volkswagenchick 
    Issue #3006824 by volkswagenchick, alonaoneill, wundo: README configs...
wundo’s picture

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

Nice work, thanks!

Status: Fixed » Closed (fixed)

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