Last updated April 15, 2012.
Project pages should be helpful; there are literally thousands of modules, themes and installation profiles and site builders need a clear way to understand what your project does.
A great writeup about what to include in your project page is Module owners: How to make your module description useful by lisarex. Lisa suggests you include these sections in your project page:
What does the project do? What problem does it solve? Who is the intended audience?
A bulleted list of features to help people quickly figure out if it's useful to them.
Describe required PHP version, link to required modules and any other extraordinary items or steps needed to install or use.
- Screenshots of administration screens as well as an example of the module's output in the browser. You can upload the images when you edit your project page.
- Known problems
Be upfront about any known problems, bugs, etc. Link to active issues regarding those problems. Tip: use [#nnn] syntax and Drupal.org will automatically link to the issues and show their current status inside the node body.
- Links to Documentation
- INSTALL.txt (if any)
- Drupal.org Documentation page
- Recommended modules
- Similar projects