Incorrectly says README.md needs uppercase headings

Created on 23 May 2024, 11 months ago

Problem/Motivation

README.md files should have title-case headings, not uppercase. The script provides incorrect recommendations.

https://www.drupal.org/node/2181737#s-changes-from-readmetxt

Steps to reproduce

$ ./pareview.sh https://git.drupalcode.org/project/mosparo_integration 1.0.x
Review of the 1.0.x branch (commit 10f99b3):
<ul>
<li>Your README.md does not follow best practices (headings need to be uppercase). See https://www.drupal.org/node/2181737 .
<ul>
<li>The INTRODUCTION section is missing.</li>
<li>The REQUIREMENTS section is missing.</li>
<li>The INSTALLATION section is missing.</li>
<li>The CONFIGURATION section is missing.</li>
</ul></li>

See the README.md here.

Proposed resolution

Markdown file headings should be checked for title-case instead.

Remaining tasks

User interface changes

API changes

Data model changes

🐛 Bug report
Status

Active

Version

1.0

Component

Default

Created by

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

Comments & Activities

Production build 0.71.5 2024