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

CommentFileSizeAuthor
#5 readme_for_d7_branch-2863085-5.patch5.09 KBdhruveshdtripathi
#2 google_tag-add-readme-2863085-2.patch5.1 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
google_tag-add-readme-2863085-2.patch5.1 KB

I attached a patch which includes a useful README for the D7 branch.
Thanks for the module!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Title: README fro D7 Branch » README for D7 Branch
Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Needs review » Needs work

@volkswagenchick, Thanks for the patch but need to change or remove the extra line after each section.

dhruveshdtripathi’s picture

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda for OpenSense Labs commented
Status: Needs work » Needs review
FileSize
readme_for_d7_branch-2863085-5.patch5.09 KB

Removed those extra lines.

Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Needs review » Reviewed & tested by the community

@dhruveshdtripathi, Thanks for the quick patch, now it works well

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented

According to Drupal documentation standards: there should be "Two lines prior to headings (except the first one)."
https://www.drupal.org/node/2181737

So the patch I submitted in comment #2 is closer to standards. Thanks!

dhruveshdtripathi’s picture

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda for OpenSense Labs commented

Yes @volkswagenchick, you're right. Sorry for creating the new patch. Your patch is closer to standards. Patch #2 is OK.

Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented

@volkswagenchick, Apologies, I missed that point. Will take a learning note and contribute accordingly.

solotandem’s picture

solotandem CreditAttribution: solotandem commented
Version: 7.x-1.1 » 7.x-1.x-dev
Assigned: Unassigned » solotandem
Status: Reviewed & tested by the community » Fixed

See above commit.

solotandem’s picture

solotandem CreditAttribution: solotandem commented
volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented

@solotandem,
I really like using this module and that is one of the reasons I decided to write a useful README. Could you give please give me and the community member who RTBCed a commit credit or credit for helping out with the project?
I think giving the community credits/commit credits helps with incentives for future community involvement.
Thanks again for working on this module!
Cheers,
AmyJune (volkswagenchick)

Status: Fixed » Closed (fixed)

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