Drupaltools Contrib Readme

Drupal Contributed Module README

Generate and validate README.md files following Drupal.org contribution guidelines.

When to Use

Use this skill when:

• "Generate a README.md for my Drupal module"
• "Check my README.md for Drupal.org compliance"
• "Fix README structure issues"
• "Add missing README sections"

README.md Requirements

Required Sections

Optional Sections

Prohibited Content

Never include:

• File structure diagrams/sections
• Installation instructions (composer require, drush en)
• "How to install" sections
• Beginner-friendly explanations
• composer.lock mentions

Generate README.md

Process

1. Read existing MODULE.info.yml to extract:

   • Module name and description
   • Core version requirement
   • Dependencies

2. Check for services file:

   ls MODULE.services.yml 2>/dev/null && echo "has_services"
   

3. Generate README with appropriate sections

README Template

# Module Name

About
-----
Introduction summarizing purpose and function. First ~200 characters shown in 
project listings. Accessible to users new to Drupal.

Features
--------
Basic functionality, unique features, and use cases.

Requirements
------------
Required modules and dependencies.

Example code
------------
Code examples for developers.

Extend and override
-------------------
Hooks, events, and extension points.

Supporting this Module
---------------------
Information about financial support or sponsorships.

Contributing
------------
Guidelines for contributing to the module.

Community Documentation
------------------------
Links to external resources, videos, demos.

Validate README.md

Check List

1. Section presence - All required sections exist
2. Section order - Follows Drupal.org ordering
3. No prohibited content - No install instructions, file structures
4. Code examples - Follow Drupal coding standards
5. Content level - Targets experienced developers

Validation Output

✅ README.md VALIDATION PASSED

Required Sections: ✅ All present
- About section
- Features section
- Extend and override section

Content Quality: ✅ Good
- Targets experienced developers
- No installation instructions
- No file structure section

Recommendations:
- Consider adding "Example code" section for developer clarity

Common Issues

Resources

• Drupal.org: Module Documentation
• Drupal.org: Readme Template