Replace README.txt with README.md

Created on 15 November 2022, almost 2 years ago
Updated 3 July 2024, 3 months ago

We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation.

Follow this pattern
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... โ†’

๐Ÿ“Œ Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia phpsubbarao

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

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Merge request !2Update README.txt โ†’ (Open) created by Manoj Raj.R
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Bushra Shaikh

    I verified and applied MR !1 for Drupal version 10.0.2.
    README.txt file updated to README.md after applying this patch.

    can be move to RTBC+1

  • Issue was unassigned.
  • Status changed to Needs work 12 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi Manoj Raj.R

    I reviewed your MR!2 but it doesn't follow README.md template. โ†’ These are the README sections recommended by Drupal:

    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)
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    ravi kant โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 7 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    Updated README file on MR !2

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia dev16.addweb

    silvi.addweb โ†’ made their first commit to this issueโ€™s fork.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia dev16.addweb

    Hi @ravi-kant,
    The README.md looks good. I have tested it for PHPCS issues and fixed the ones I found. Please review.

    custom/taxonomy_breadcrumb/README.md
    -------------------------------------------------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    -------------------------------------------------------------------------------------------------------------------------
     76 | ERROR | [x] Expected 1 newline at end of file; 0 found
    -------------------------------------------------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    -------------------------------------------------------------------------------------------------------------------------
    
    Time: 49ms; Memory: 10MB
    
  • Status changed to Needs work 3 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi silvi.addweb

    I reviewed your changes and the "**Examples:**" should be about the project page and issue queue links so it has better readability. The The taxonomy_breadcrumb module generates should be "The Taxonomy Breadcrumb" no need to make it a machine name.

    Thanks

  • Status changed to Needs review 3 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia dev16.addweb

    Hi @kenyoowen,
    I have updated README.md as per #9. Please review it.

  • Status changed to Needs work 3 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi silvi.addweb

    I reviewed your changes but the "**Examples:**" isn't above the Project and issue queue link.
    It should be like this

    **Examples:**
    
    - home >> term >> term
    - mysite >> term >> term
    - home >> vocabulary >> term >> term
    - vocabulary >> term >> term
    
    For a full description of the module, visit the
    [project page](https://www.drupal.org/project/taxonomy_breadcrumb).
    
    Submit bug reports and feature suggestions, or track changes in the
    [issue queue](https://www.drupal.org/project/issues/taxonomy_breadcrumb).
    
    
  • Status changed to Needs review 3 months ago
  • Status changed to RTBC 3 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi silvi.addweb

    I reviewed your changes in MR!2 and it fixed comment #14. The README.md 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.

Production build 0.71.5 2024