Project page template

A good project page presents an overview of a module/theme/distribution’s functionality. It needs to be written so that the average user or website builder can understand what it does and whether it will assist them with their project. The project page needs to be concisely written and regularly updated.

When creating a new Drupal module at https://www.drupal.org/node/add/project-module, the Description is populated by a default template. The suggested contents below are based on that.

Suggested contents

Summary

Click "Edit summary" above the Description field to enter the project Summary. It should be 200 characters or less. It will be shown when browsing projects using the Project Browser. If you leave it empty, the first 200 characters of the Description (below) will be shown.

Description

Write an introduction that summarizes the purpose and function of this project with a focus on users brand new to Drupal. Answer the question: What solution does this module provide?

Features

Answer the following questions: What is the basic functionality? What unique features does enabling this project add? When and why would someone use this module? What use cases are there?

Post-installation

How does this module actually work once I install it? Should I go to a config page? Should I look for a new content type? Should I go and manage my text formats? Provide an overview of the configuration process and any other special considerations for the module.

Additional requirements

Does this project need anything beyond Drupal core? Include any dependent modules, libraries, APIs, etc., that are required for this project to work.

Recommended modules/libraries

Are there any projects that enhance or improve the functionality of this project?

Similar projects

If there are modules providing similar functionality, please describe what differentiates them.

Supporting this module

If you have a Patreon, OpenCollective, etc. you can put links here to describe how people can support development. 

Community documentation

A great place to add links to external documentation, tutorials, YouTube walkthroughs, blog posts etc..

Additional information may be added, if there are other things you think people need to know about your module. This might include, for example, a list of important known issues with links to their issue pages, or a roadmap.

Images

Images can be uploaded to the project page using the Images form for a new project, or the File attachments form for an existing project.

Images hosted on drupal.org can be embedded by using the image icon at the top of the project Description or Summary field. Remove https://www.drupal.org from the start of the image's URL so that it starts with /files/issues/. Fill a brief description of the image in the Alternative text field. Fill in the Width and Height fields if you do not want the image to be displayed at full size. Example:

If images are uploaded to a project page, previews of them will appear in a vertical column at the top right of the Description, even if they are not manually embedded.

Resources field

The Edit page has a tab labeled "Resources" near the bottom:

Explanation of the Resources fields:

• Home page: If you've created a home page for your project at your own (or your company's) website, you should put its URL here. This appears in the sidebar of the project page.
• Changelog: Link to the project's CHANGELOG.txt in the repository, if there is one. This appears in the sidebar of the project page.
• Demo: If you've created a demo site for your project, you should put its URL here. One way to do this is to make a link to simplytest.me with a URL like https://simplytest.me/project/[module_machine_name] This appears in the sidebar of the project page.
• Documentation: Link to the Drupal.org Community Documentation page for the project if it exists, otherwise, link to the project's README.txt or README.md in the repository. This appears in the sidebar of the project page.
• Screenshots: Link to a page of screenshots demonstrating the project. Include, for example, screenshots of administration screens as well as an example of the module's output in the browser. Screenshots hosted on drupal.org may also be embedded directly in the project page. See Images (above).

Inspiration

Projects by 1xINTERNET are using a great looking template. See, for example, https://www.drupal.org/project/content_templates.