Problem/Motivation

  1. The README.md file is missing.
  2. The help page is missing.

Proposed resolution

  1. Create README.md file

    2. See: README template

  2. Implement hook_help().

    3. See: Module documentation guidelines | hook_help

Remaining tasks

  1. Create patch
  2. Review/RTBC
  3. Commit

User interface changes

Provide module overview page.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#7 comment_notify-3035556-7.patch4.42 KBgnuget
#7 comment_notify-3035556-4-7-interdiff.txt2.88 KBgnuget
#4 comment_notify-added_readme-3035556-4.patch4.45 KBi-trokhanenko
#2 Read-me-3035556-2.patch1.31 KBDeeksha B

Comments

Deeksha B created an issue. See original summary.

Deeksha B’s picture

Deeksha B commented
Status: Active » Needs review
StatusFileSize
new Read-me-3035556-2.patch1.31 KB

Readme file added

gnuget’s picture

gnuget
Primary language Spanish
commented
Status: Needs review » Needs work

Thanks for your contribution!

I reviewed the patch and I found some issues:

  1. Typo :-) 
    +CONFIGURATION
+-------------
+
+1. go to /extand and enable the module.
+
  2. Portfolio? 
    +1. Download portfolio (https://www.drupal.org/project/comment_notify) and
+   locate this in /module folder.

Thanks!

i-trokhanenko’s picture

i-trokhanenko
Location Lutsk 🇺🇦
commented
Category: Support request » Task
Issue summary: View changes
Status: Needs work » Needs review
StatusFileSize
new comment_notify-added_readme-3035556-4.patch4.45 KB
i-trokhanenko’s picture

i-trokhanenko
Location Lutsk 🇺🇦
commented
Issue summary: View changes

Added Readme file according to the Drupal documentation - README template
Also implemented hook_help according to the Drupal documentation - Module documentation guidelines | hook_help

Please review patch #4

Roman Dyn’s picture

Roman Dyn commented
Issue summary: View changes
Status: Needs review » Reviewed & tested by the community

README file looks good. Well done! Please commit.

gnuget’s picture

gnuget
Primary language Spanish
commented
StatusFileSize
new comment_notify-3035556-4-7-interdiff.txt2.88 KB
new comment_notify-3035556-7.patch4.42 KB

I got several warnings when I applied the patch:

git apply -v --index comment_notify-added_readme-3035556-4.patch
comment_notify-added_readme-3035556-4.patch:9: trailing whitespace.

comment_notify-added_readme-3035556-4.patch:16: trailing whitespace.

comment_notify-added_readme-3035556-4.patch:17: trailing whitespace.

comment_notify-added_readme-3035556-4.patch:21: trailing whitespace.
Comment Notify is a lightweight tool to send notification e-mails to visitors about new,
comment_notify-added_readme-3035556-4.patch:22: trailing whitespace.
published comments on pages where they have commented.
Checking patch README.md...
Checking patch comment_notify.module...
Applied patch README.md cleanly.
Applied patch comment_notify.module cleanly.
warning: squelched 9 whitespace errors
warning: 14 lines add whitespace errors.

It seems that the patch had several trailing whitespaces, I removed them in this new patch.

I'm going to commit this later today.

Thanks for all the work done here.

  • gnuget committed def83a1 on 8.x-1.x 
    Issue #3035556 by gnuget, Deeksha B, i-trokhanenko: Add README.txt file
gnuget’s picture

gnuget
Primary language Spanish
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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

Deeksha B’s picture

Deeksha B commented