Please replace README.txt with README.md

Created on 3 March 2024, 9 months ago
Updated 6 June 2024, 5 months ago

Instead of README.txt, we could utilize README.md for better rendering through markdown formatting.

Given our transition to GitLab, it's advisable to opt for Markdown over plain .txt files for our documentation.

Please follow this pattern:- https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

📌 Task
Status

RTBC

Version

2.0

Component

Documentation

Created by

🇮🇳India vishal-yadav

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

Merge Requests

Comments & Activities

  • Issue created by @vishal-yadav
  • First commit to issue fork.
  • Merge request !4#3425232 - Update README → (Open) created by rishabjasrotia
  • Assigned to rishabjasrotia
  • Status changed to Needs review 9 months ago
  • Status changed to Needs work 9 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi rishabjasrotia

    I reviewed your MR!4 replacing txt to md isn't correct, the README.md file should be following the format of 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 9 months ago
  • Status changed to Needs work 6 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi rishabjasrotia

    I reviewed your changes and still missing a link to the project page and issue queue in Project name and introduction section and the installation section the link should be replaced to https://www.drupal.org/docs/extending-drupal/installing-drupal-modules and format is wrong for install section it should be For further information, see and maintainer format is wrong also it should be

    - Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
    - Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)

    .

    Thank you

  • First commit to issue fork.
  • Issue was unassigned.
  • 🇮🇳India deepak5423

    @kenyoOwen @vishal-Yaduvanshi please review the changes.

  • Status changed to Needs review 6 months ago
  • Status changed to RTBC 6 months ago
  • Hi @deepak5423,

    Applied your MR !4, all concerns about the standard format is confirmed fixed.

    Will change the status to RTBC.
    Thank you.

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

    Hi deepak5423

    I reviewed your changes and you should remove the URL for the module in the Project name and Introduction section which is this one [Give](https://www.drupal.org/project/give) and wrong format in the maintainer section it should be

    ## Maintainers
    
    - Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
    - Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)
    - Stefan M. Kudwien - [smk-ka](https://www.drupal.org/u/smk-ka)
    - Dave Reid - [Dave Reid](https://www.drupal.org/u/dave-reid)

    Thanks,
    Ken.

  • Status changed to Needs review 5 months ago
  • 🇮🇳India deepak5423

    @kenyoOwen I have updated the MR according to the standards.
    Please review

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

    Hi deepak5423

    I reviewed your changes and it fixed the issues mentioned in comment #12. The README.md file now follows the README.md template.

    Thanks.

Production build 0.71.5 2024