Contrib.social

Replace the README.txt file with the README.md file

Open on Drupal.org →
Created on 28 September 2023, 9 months ago
Updated 2 October 2023, 9 months ago

Problem/Motivation

This module uses a README.txt file as documentation file. Since drupal.org migrated to Gitlab, which renders a Markdown file as HTML, that file should be replaced by a README.md file that uses the template defined in README.md template → .

Proposed resolution

Convert README.txt to REDME.md

📌 Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

🇮🇳India Sahana _N

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

Comments & Activities

  • Issue created by @Sahana _N
  • @sahana-_n opened merge request.
  • Status changed to Needs review 9 months ago
  • Comment 9 months ago →
    🇮🇳India Sahana _N

    Please review the patch.

  • Status changed to Needs work 9 months ago
  • Comment 9 months ago →
    🇵🇭Philippines kenyoOwen

    Hi Sahana _N

    I applied and reviewed your MR!1 and it doesn't convert README.txt to README.md. My suggestion is to create a new file which is README.md and delete the file README.txt. And make sure your README.md is based on README.md template → . And these are the README sections that Drupal Recommends: 

    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
  • Comment 9 months ago →
    🇮🇳India Sahana _N

    Created a patch Please review it.

  • First commit to issue fork.
  • Comment 9 months ago →
    thakurnishant_06 India
  • Status changed to RTBC 9 months ago
  • Comment 9 months ago →
    🇵🇭Philippines kenyoOwen

    Hi thakurnishant_06

    I reviewed your changes in MR and confirmed that it follow the README.md template.

    Thank you.

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024