README.md does not follow best practice

Created on 24 May 2018, about 6 years ago
Updated 27 September 2023, 9 months ago

Your README.md does not follow best practices (headings need to be uppercase). See https://www.drupal.org/node/2181737 .

The INTRODUCTION section is missing.
The REQUIREMENTS section is missing.
The INSTALLATION section is missing.
The CONFIGURATION section is missing.

Here is a summary of the preferred format for README.md:

  • Headings in all caps.
  • Headings underlined with ===/--- to the length of the heading, followed by a blank line.
  • Two lines prior to headings (except the first one).
  • Bullets denoted by asterisks (*) with hanging indents.
  • Numbered lists indented 4 spaces.
  • Bulleted lists indented 1 space.
  • Text manually word-wrapped within around 80 cols.
🐛 Bug report
Status

Needs work

Version

1.0

Component

Documentation

Created by

🇮🇳India Akshay kashyap

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

Comments & Activities

Not all content is available!

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

Production build 0.69.0 2024