Module Rep Templates

This page holds the templates for module info. Each module in Overture (IDE or Core) must have a copy of this template in its root folder. It is the responsibility of each rep to ensure that the information is up to date.

You can select from one of two templates. It's up to you which one you want but the file extension must match the version you pick or it won't render properly on GitHub. Also, it must be named README.

Markdown (README.md)

This is the Markdown version of the template. It looks nice in GitHub and as plain text... sort of.

- **Name:** 
of the module
- **Rep:** 
the person in charge of maintaining this document
- **Description:** 
a brief informal description of the module’s functionality and its current status (maintenance, new feature, etc.)
- **Known Issues:** 
any major problems with the code (bugs, outdated stuff, etc.)
- **Contributors:** 
list of people who have worked on the module and have active knowledge of how it works

You can add some free-form text at the end here but don't get cute. This is a quick reference.

reStructured (README.rst)

This is a more structured version of the template. It looks nice in GitHub but not super nice in plain text.

:Name: 
  of the module
:Rep: 
  the person in charge of maintaining this document
:Description:
  a brief informal description of the module’s functionality and its current status (maintenance, new feature, etc.)
:Known Issues: 
  any major problems with the code (bugs, outdated stuff, etc.)
:Contributors: 
  list of people who have worked on the module and have active knowledge of how it works

There's room at the end for some free-form text. Add anything relevant but, again, don't get too fancy.