Missing README.md File for the Module

Created on 14 March 2024, 7 months ago
Updated 24 May 2024, 4 months ago

Problem/Motivation

I noticed that the module does not have a README.md file included in its repository. A README file is crucial as it usually contains important information about the module, such as its purpose, installation instructions, usage examples, and any dependencies it might have.

Follow this pattern for the README File:
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

📌 Task
Status

RTBC

Version

1.1

Component

Documentation

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @sunil_lnwebworks
  • Status changed to Needs review 7 months ago
  • I created a readme template where author can easily update the requirements as per need, Please refer to the attached Patch File

  • Status changed to Needs work 7 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi sunil_lnwebworks

    I reviewed your patch and it doesn't follow the README.md template .

    Drupal recommends the following README sections:
    
    Project name and introduction (required)
    Table of contents (optional)
    Requirements (required)
    Recommended modules (optional)
    Installation (required, unless a separate INSTALL.md is provided)
    Configuration (required)
    Troubleshooting & FAQ (optional)
    Maintainers (optional)

    Thank you

  • Status changed to Needs review 7 months ago
  • Hi @kenyoOwen,

    I've made updates to the Readme in accordance with the documentation. Please refer to the Patch File Updated-Readme-File.patch

  • Status changed to Needs work 5 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi sunil_lnwebworks

    I reviewed your updated patch missing a link to the project page and issue queue, requirements format is wrong it should be modules if no requirement module it should be This module requires no modules outside of Drupal core..

    Thank you

  • First commit to issue fork.
  • Merge request !23427837: Adding the README.md file. → (Open) created by Diwakar07
  • Status changed to Needs review 5 months ago
  • 🇮🇳India Diwakar07

    Hi, I have created an MR for the missing README.md file.
    Updated the README file based on the suggestion by @kenyoOwen.
    Please review.

  • Status changed to Needs work 4 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi Diwakar07

    I reviewed your changes and it fixes comment #5 I noticed that there is a ditto mark symbol or ("") in the module name in the introduction section and it should be remove and also the Table of Contents need to be replace as Table of contents.

    Thank you

  • Status changed to Needs review 4 months ago
  • 🇮🇳India Diwakar07

    Hi @kenyoOwen,
    Thanks for the feedback.
    I have updated the MR accordingly. Please review.

  • Status changed to RTBC 4 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi Diwakar07

    I reviewed your changes and I confirmed that it now follows the README.md template.
    https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template

    Thanks,
    Ken.

Production build 0.71.5 2024