Menu
Generate and validate README.md files for Drupal.org contribution. Use this skill when you need to create a README.md for a Drupal module, check an existing README for Drupal.org compliance, or fix README structure issues.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Run the project markdownlint script in a Drupal project and fix the reported markdown violations. Use this skill whenever the user asks to run markdownlint, lint markdown, check the docs, or says "run scripts/markdownlint.sh and fix the errors".
Run PHPCS in a Drupal project and fix the reported coding standards violations. Use this skill whenever the user asks to run phpcs, check coding standards, fix code style errors, lint PHP/Drupal code, or says things like "run phpcs and fix the errors" or "clean up my coding standards".
Run PHPStan static analysis in a Drupal project and resolve the reported errors. Use this skill whenever the user asks to run phpstan, run static analysis, fix type errors, or says "run phpstan and fix the errors".
Run the custom PHPUnit test suite in a Drupal project and fix the reported failures and errors. Use this skill whenever the user asks to run phpunit, run the tests, run the custom testsuite, or says "run phpunit and fix the errors".
Estimate costs and timeline for Drupal projects using a structured breakdown of tasks, roles, content types, and development work. Use this skill when the user asks for a project quote, cost breakdown, timeline estimation, budget planning, or resource allocation for a Drupal website. Trigger for requests like "how much would this Drupal project cost", "estimate this project", "create a quote", "plan the budget", or any discussion about pricing/timeline for Drupal development.
Create a Drupal.org issue title and summary body that is ready to paste into the issue form. Use when the user asks to draft, improve, or rewrite an issue from a bug report, feature request, patch, MR, commit, or discussion. When the user says "issue title", "issue body", "issue summary", or similar.
Based on SOC occupation classification
| name | drupaltools-contrib-readme |
| description | Generate and validate README.md files for Drupal.org contribution. Use this skill when you need to create a README.md for a Drupal module, check an existing README for Drupal.org compliance, or fix README structure issues. |
Generate and validate README.md files following Drupal.org contribution guidelines.
Use this skill when:
| Section | Required | Description |
|---|---|---|
| About | Yes | Module purpose, first ~200 chars shown in listings |
| Features | Yes | Functionality and use cases |
| Extend and override | Recommended | Hooks, events, extension points |
| Section | When to Include |
|---|---|
| Requirements | If dependencies exist |
| Recommended modules | If complementary modules enhance functionality |
| Example code | For developer-facing modules |
| Similar projects | To differentiate from alternatives |
| Basic Services | Only if MODULE.services.yml exists |
| Supporting this Module | For sponsored/supported modules |
| Contributing | For community-contributed modules |
| Community Documentation | External resources, videos, demos |
Never include:
composer require, drush en)composer.lock mentionsRead existing MODULE.info.yml to extract:
Check for services file:
ls MODULE.services.yml 2>/dev/null && echo "has_services"
Generate README with appropriate sections
# 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.
✅ 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
| Issue | Fix |
|---|---|
| File structure section | Remove any file/folder diagrams |
| Installation instructions | Remove "How to install" sections |
| Beginner content | Rewrite for experienced developers |
| Missing About section | Add introduction, first ~200 chars |