Project page template

Last updated on
3 August 2023

A good project page is a concise 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. See also Module owners: How to make your module description useful by lisarex.

Suggested contents

Synopsis

This should start out with telling users what the project does, what problem it solves, and who the intended audience is. Main features of the project should be highlighted, but avoid hyperbole and do not try to oversell the project. The synopsis should provide enough information for the user to evaluate whether it will suit their needs before they download and install the module.

Provide a bulleted list of features to help people quickly figure out if it's useful to them.

Add in a screenshot if it can illustrate what it does.

Requirements

Link to required contributed modules, themes, and any other extraordinary items or steps needed to install or use.

Mention and link to all required external libraries and other third-party resources.

List any module that is not required, but will, if enabled, enhance the usefulness or the user's experience of the project. Describe the functionality and integration of the module when it is enabled.

Roadmap

If the project is still being developed, include a "roadmap" section where you state your plans about further developments for the module. You may also use this section to request patches for specific features that are planned, but you have to found the time to implement yet.

If the project is considered complete, or if a branch is minimally maintained, this should also be stated up-front in this section.

Known problems

Be upfront about known problems and limitations. Provide instructions about workarounds.

Link to active issues regarding those problems. Tip: use [#nnnnn] syntax and drupal.org will automatically link to the issues and show their current status inside the body of the project page.

Pledges

Pledge that your project will be ready for the next major version of Drupal!

Credits

Who are the present maintainers that are officially behind the project and responsible for providing oversight, maintenance, and support? Provide a bulleted list.

Credits for important past contributors that are not current maintainers may also be listed.

Sponsoring organizations can also be listed. It is OK to be bold and provide logos and links.

Donations

If people want to give, provide a link to your funding platform to make it easy for them to do so. There's really no reason not to put in a prominent ask here.

Help wanted!

If a co-maintainer is needed to assist in maintaining the project, state this on the project page.

Bullet list of similar projects (with a link to the project page of each project). Make sure you also explain how they are different from your project.

Dependencies

If the project is a bridge or interface module that is not fully functional on its own, but instead relies on some external service (e.g. SaaS) to be fully functional, such external dependencies should be disclosed on the project page, with a link to the external service.

If the external service is a premium service (i.e. access to some of its features and services are restricted unless money changes hands), the pricing plan for the external service should also be disclosed, for instance by linking to the external premium service price list.

Restrictions

If the version of your project that can be downloaded from the Drupal.org Git Repository has some artificial restrictions in place (e.g. the number of records it can manage is limited), and these restrictions can be lifted by purchasing a premium version, all such restrictions should be disclosed on the web page. Please link to the web-page that discloses the cost of obtaining a premium version of the module.

Template (to copy & paste):

<h3 id="project-description">Synopsis</h3>
(text)
<h3 id="project-requirements">Requirements</h3>
(text)
<h3 id="project-recommended">Recommended modules</h3>
(text)
<h3  id="project-roadmap">Roadmap</h3>
(text)
<h3 id="project-problems">Known problems</h3>
(text)
<h3 id="project-pledges">Pledges</h3>
(text)
<h3 id="project-maintainers">Credits</h3>
(text)
<h3 id="project-donations">Donations</h3>
(text)
<h3 id="project-help">Help wanted!</h3>
(text)
<h3 id="project-related">Similar projects and how they are different</h3>
(text)
<h3 id="project-dependencies">Dependencies</h3>
(text)
<h3 id="project-restrictions">Restrictions</h3>
(text)

Resources field

The edit page has a tab labeled "Resources" near the bottom:
Screen shot of resources on project page

Explanation of the Resources fields:

  • Screenshots: Use this to include screenshots of administration screens as well as an example of the module's output in the browser. The screenshot will appear in the top right corner of your project page.
  • Documentation: Link to the Drupal.org Community Documentation page 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.
  • 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.
  • Changelog: Link to the project's CHANGELOG.txt in the repository. This appears in the sidebar of the project page.
  • Homepage: 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.

Help improve this page

Page status: No known problems

You can: