According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....

README to follow. Thanks!

CommentFileSizeAuthor
#7 interdiff-2843184-2-7.txt620 bytesDave Kopecek
#7 hacked-add-readme-2843184-7.patch2.82 KBDave Kopecek
#4 interdiff-2843184-2-4.txt767 bytesDave Kopecek
#4 hacked-add-readme-2843184-4.patch2.82 KBDave Kopecek
#2 hacked-add-readme-2843184-2.patch2.55 KBvolkswagenchick
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Assigned: volkswagenchick » Unassigned
Status: Needs work » Needs review
FileSize
hacked-add-readme-2843184-2.patch2.55 KB

I have attached a patch with a useful README.
Thanks!!

idsdrup’s picture

idsdrup CreditAttribution: idsdrup at Hook 42 commented
Status: Needs review » Reviewed & tested by the community

Reviewed, moving to RTBC

Dave Kopecek’s picture

Dave Kopecek
he/him
CreditAttribution: Dave Kopecek commented
FileSize
hacked-add-readme-2843184-4.patch2.82 KB
interdiff-2843184-2-4.txt767 bytes

I added a drush section

Drush commands in hacked:
 hacked-details (hd)   Show the Hacked! report about a specific project.
 hacked-diff           Output a unified diff of the project specified.
 hacked-list-projects  List all projects that can be analysed by Hacked!
Dave Kopecek’s picture

Dave Kopecek
he/him
CreditAttribution: Dave Kopecek commented
Status: Reviewed & tested by the community » Needs review
volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Status: Needs review » Needs work

Dave, i like that you added a section for Drush commands. Looks good. Thanks!
I do think that the Maintainer section should be inserted back into the README as per the documentation guidelines.

Dave Kopecek’s picture

Dave Kopecek
he/him
CreditAttribution: Dave Kopecek commented
FileSize
hacked-add-readme-2843184-7.patch2.82 KB
interdiff-2843184-2-7.txt620 bytes

Didn't mean to do that... Let's try again.

Dave Kopecek’s picture

Dave Kopecek
he/him
CreditAttribution: Dave Kopecek commented
Status: Needs work » Needs review
volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Status: Needs review » Reviewed & tested by the community

Look great! Thanks for adding those drush commands! Making as RTBC

  • colan committed a7f90d9 on 7.x-2.x authored by volkswagenchick 
    Issue #2843184 by Dave Kopecek, volkswagenchick, colan: Added missing...
colan’s picture

colan
he/him
Primary language English
Location Toronto 🇨🇦
CreditAttribution: colan at Consensus Enterprises, Colan Schwartz Consulting commented
Status: Reviewed & tested by the community » Fixed

Thanks. Added myself as a maintainer too.

Status: Fixed » Closed (fixed)

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