Skip to content

Update README template to better align with drupal.org template - #224

Open
gitressa wants to merge 4 commits into
Chi-teck:4.xfrom
gitressa:4.x
Open

Update README template to better align with drupal.org template#224
gitressa wants to merge 4 commits into
Chi-teck:4.xfrom
gitressa:4.x

Conversation

@gitressa

@gitressa gitressa commented Aug 6, 2026

Copy link
Copy Markdown

The tool works great, and I just generated a module with it.

I did notice that there a few differences between the resulting README and the drupal.org README.md template, so perhaps we can make a few adjustments, to better align them?

This would also allow us to remove this tip on the README.md template page:

You can generate a boilerplate README.md with the following command: drush generate readme. The generated text does not follow these guidelines exactly, but may serve as a good starting point.

The PR makes these changes:

  • Project name is the first line of the document, and only level one heading (#)
  • Headings capitalized with an initial capital, following standard English sentence rules
  • Two lines prior to ##/### headings
  • Link module installation to current Drupal 11 page (was Drupal 7)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant