Problem/Motivation

Your README.md does not follow best practices.
To prepare the Conditional Fields to security advisory coverage we need to improve the README.md

Proposed resolution

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.

CommentFileSizeAuthor
#2 conditional_fields-Your_READMEmd_does_not_follow_best_practices-3144407-d8-2.patch5.67 KBpaulocs
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

paulocs created an issue. See original summary.

paulocs’s picture

paulocs
Primary language Portuguese, Brazil
Location Belo Horizonte
CreditAttribution: paulocs at CI&T commented
Status: Needs work » Needs review
FileSize
conditional_fields-Your_READMEmd_does_not_follow_best_practices-3144407-d8-2.patch5.67 KB

Follow a patch

thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
CreditAttribution: thalles at CI&T commented
Status: Needs review » Reviewed & tested by the community

Looks good to me!

  • thalles committed bef2d43 on 8.x-1.x authored by paulocs 
    Issue #3144407 by paulocs: Your README.md does not follow best practices
thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
CreditAttribution: thalles at CI&T commented
Status: Reviewed & tested by the community » Fixed

  • thalles committed 224730a on 8.x-1.x authored by paulocs 
    Issue #3144407 by paulocs: Your README.md does not follow best practices
thalles’s picture

thalles
Primary language Portuguese, Brazil
Location Teófilo Otoni - MG
CreditAttribution: thalles at CI&T commented

Thanks for your help @paulocs!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.