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

CommentFileSizeAuthor
#8 interdiff-2832272-6-8.txt1.35 KBvolkswagenchick
#8 advanced_help-add-readme-2832272-8.patch1.82 KBvolkswagenchick
#6 advanced_help-add-readme-2832272-6.patch1.82 KBvolkswagenchick
#5 read-me-page-2832272-5.png378.8 KBamit.drupal
#5 read-me-link-2832272-5.png27.67 KBamit.drupal
#4 advanced_help-add-readme-2832272-4.patch1.85 KBvolkswagenchick
#2 advanced_help-add-readme-2832272-2.patch1.85 KBvolkswagenchick

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
StatusFileSize
new advanced_help-add-readme-2832272-2.patch1.85 KB

Here's a patch that contains a README.txt

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Title: Add README file » Add README file for D8

Thanks for the patch. See this comment for the D7 patch:

https://www.drupal.org/node/2832269#comment-11807327

for standardization of module name.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
StatusFileSize
new advanced_help-add-readme-2832272-4.patch1.85 KB

Here is a revised patch with consistent naming.
Thank you Kristen Pol and Loopduplicate for reviewing.

amit.drupal’s picture

amit.drupal commented
StatusFileSize
new read-me-link-2832272-5.png27.67 KB
new read-me-page-2832272-5.png378.8 KB

Review Patch #4 found some issues.

Change current file name "advanced_help d8.txt" to README.txt file.
I install module and found read me link before apply patch.
i think there is no need for read me file.
PFA.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
StatusFileSize
new advanced_help-add-readme-2832272-6.patch1.82 KB

I changed the name of the file to the appropriate name. There is some help language within the configuration but that requires installation of the module.
According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu...

A README file within the module allows users to read about the module before installation to see if the module has the desired functionality.

Thankyou.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Thanks for the update. When updating patches, it's useful to add an interdiff file:

https://www.drupal.org/documentation/git/interdiff

so only the differences need to be reviewed. Thanks.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
StatusFileSize
new advanced_help-add-readme-2832272-8.patch1.82 KB
new interdiff-2832272-6-8.txt1.35 KB

Here is a revised patch and an interdiff that resolves the naming patterns and extra spaces.

gnuget’s picture

gnuget
Primary language Spanish
commented
Status: Needs review » Fixed

Thank you very much!

Status: Fixed » Closed (fixed)

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