Readme.md file missing

Created on 18 July 2024, 10 months ago

Problem/Motivation

Adding Readme.md file into project will help developers to understand on module.

Proposed resolution

Create a Readme.md file according to Readme.md file format.

📌 Task
Status

Active

Version

1.0

Component

Documentation

Created by

🇮🇳India amanbtr72

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

Comments & Activities

  • Issue created by @amanbtr72
  • Assigned to siddhraj
  • 🇮🇳India siddhraj Rajasthan
  • 🇮🇳India siddhraj Rajasthan

    I created a README.md file for the seo_analyzer module. It includes a brief module description, installation instructions, configuration steps and features. The file also includes a list of current maintainers

  • 🇮🇳India siddhraj Rajasthan
  • 🇵🇭Philippines kenyoOwen

    Hi siddhraj

    I reviewed your patch and it seems missing a issue queue link in the introduction, requirements sections, and configuration, features, and maintainers section should have two heading prefixes only. Maintainer has a wrong format, it should be - Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun). And I think it's better to have an M.R. rather than a patch.

    Thanks.

  • 🇮🇳India siddhraj Rajasthan

    Hii Kenyoowen

    i have added issue queue and removed extra heading from other sections, also updated maintainer format as per drupal standard.

  • 🇵🇭Philippines kenyoOwen

    Hi siddhraj

    I reviewed your new patch seo_analyzer_readme-3462417-6.patch and it's missing a requirements section which is required by README Requirements (required). And make sure text are manually word-wrapped within around 80 cols. Please also transition the status to needs review, if you added a new patch for review.

    Thanks

  • 🇮🇳India siddhraj Rajasthan

    Hii Kenyoowen

    i have wrapper every line under 80 cols and added requirements section as well.

    Thanks

  • 🇮🇳India siddhraj Rajasthan
  • 🇵🇭Philippines kenyoOwen

    Hi siddhraj

    I reviewed your new patch in comment #8 and it now follows the README.md template. And tested the patch on my local and it's working.

    Thanks

Production build 0.71.5 2024