Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gitressa wants to merge 4 commits into
base: 4.x
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cbd794e
Update README template to align with drupal.org
gitressa Aug 6, 2026
ea1c3ae
Update README template test
gitressa Aug 6, 2026
da58a51
Fix install link in README.md
gitressa Aug 6, 2026
a7acde3
Fix install link in README test
gitressa Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions templates/_module/README.md.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## INTRODUCTION
# {{ name }}

The {{ name }} module is a DESCRIBE_THE_MODULE_HERE.

Expand All @@ -8,23 +8,29 @@ The primary use case for this module is:
- Use case #2
- Use case #3

## REQUIREMENTS

## Requirements

DESCRIBE_MODULE_DEPENDENCIES_HERE

## INSTALLATION

Install as you would normally install a contributed Drupal module.
See: https://www.drupal.org/node/895232 for further information.
## Installation

Install as you would normally install a contributed Drupal module. For further
information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-modules).


## Configuration

## CONFIGURATION
- Configuration step #1
- Configuration step #2
- Configuration step #3

## MAINTAINERS

Current maintainers for Drupal 10:
## Maintainers

Current maintainers for Drupal 11:

- FIRST_NAME LAST_NAME (NICKNAME) - https://www.drupal.org/u/NICKNAME

22 changes: 14 additions & 8 deletions tests/functional/Generator/_module/foo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## INTRODUCTION
# Foo

The Foo module is a DESCRIBE_THE_MODULE_HERE.

Expand All @@ -8,23 +8,29 @@ The primary use case for this module is:
- Use case #2
- Use case #3

## REQUIREMENTS

## Requirements

DESCRIBE_MODULE_DEPENDENCIES_HERE

## INSTALLATION

Install as you would normally install a contributed Drupal module.
See: https://www.drupal.org/node/895232 for further information.
## Installation

Install as you would normally install a contributed Drupal module. For further
information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-modules).


## Configuration

## CONFIGURATION
- Configuration step #1
- Configuration step #2
- Configuration step #3

## MAINTAINERS

Current maintainers for Drupal 10:
## Maintainers

Current maintainers for Drupal 11:

- FIRST_NAME LAST_NAME (NICKNAME) - https://www.drupal.org/u/NICKNAME

Loading