Update README.md file according to README.md template

Created on 16 January 2023, over 1 year ago
Updated 22 December 2023, 6 months ago

This module is still using old README.md template format in README.md file.

Follow the pattern in the README.md template โ†’ .

๐Ÿ“Œ Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia Shubham Rathore Jaipur

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.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Installation section is given in Table of contents and also it is a required (mandatory) section as per readme.md file template. However it is missing from the readme.md file.

  • Status changed to Needs work 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Anjali Mehta โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Kindly review the changes.
    Thank You.

  • Status changed to RTBC 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!1, the patch is updated as per the readme.md file template. Hence marking it to RTBC.

  • Status changed to Needs work 9 months ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom rivimey

    Patch no longer applies.

  • First commit to issue fork.
  • Status changed to Needs review 9 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia sakthi_dev

    Rebased with 1.0.x latest commits. Please review. If needs changes please update.

  • Status changed to Needs work 6 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!1, the patch is not cleanly applied.

    file does not follow the readme.md template format:-
    ads via Carbon
    Get 10 Free Images From Adobe Stock. Start Now.
    ADS VIA CARBON
    Advertising sustains the DA. Ads are hidden for members. Join today
    On this page
    README format
    README sections
    Project name and introduction
    Table of contents (TOC)
    Requirements
    Recommended modules
    Installation
    Configuration
    Troubleshooting & FAQ
    Maintainers
    Changes from README.txt
    Advanced help module
    Sample README
    Documenting your project
    Help text standards
    Module documentation guidelines
    Project page template
    README Template
    Working with Drupal's Help system
    Using simplytest.me as a project demo
    Help Topic Standards
    README.md template
    Primary tabsToggle
    Edit
    Discuss
    View history
    Last updated on 30 November 2023
    The Drupal community recommends using the Markdown format to create a README.md file. For a quick introduction to Markdown, see Markdown Guide's Basic Syntax or GitLab Flavored Markdown (GLFM) for a more comprehensive run-down.
    
    README documentation can include more Markdown-features than those used in the example snippets in this template. For instance, Markdown let you create hyperlinks that can be clicked when the README.md is rendered in GitLab or by a compatible program (e.g. Advanced Help).
    
    You can generate a boilerplate README.md with the following command: drush generate readme. The generated text does not follow these guidelines exactly, but may serve as a good starting point.
    
    README format
    Drupal recommends the following README formatting:
    
    Headings capitalized with an initial capital, following standard English sentence rules
    Headings prefixed with #/##/### to indicate level of heading (h1/h2/h3) followed by a blank line
    Project name is the first line of the document, and only level one heading (#)
    Two lines prior to ##/### headings
    No leading or trailing spaces
    Bulleted lists denoted by dashes (-)
    Ordered lists use "1", for easier updates and to avoid errors (see Configuration)
    Nested lists indented with 4 spaces
    Links should have a meaningful link text, for example:
    [Drupal](https://www.drupal.org/) (i.e. not just the URL)
    Text manually word-wrapped within around 80 cols
    README sections
    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)
  • Status changed to Needs review 6 months ago
  • Status changed to RTBC 6 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi Anjali Mehta

    I reviewed your changes and applied a patch and it applied successfully on my end. And I reviewed your changes and it resolved the feedback of comment #12 and it follows the README.md template. โ†’

    Thank you

Production build 0.69.0 2024