QSOS Guidelines

Draft

List of rules and best practices one has to apply when contributing to QSOS.

Communication

Mailing-lists : for inside-project call for help and contribution, infos, news, evolutions, reviews, committing, etc.
Jabber chatroom : for unformal instant discussions/brainstorming, decisions should be synthetized to the ML and/or to the wiki
Wiki : for documentation and formalization of discussions (no discussions)

Each criterion should:
- Start with a capital letter
- Not be a sentence
- Not contain more than 3 words (if possible)
- Be as simple as possible
- desc should not contain a carriage return (one line)
Rules for the criteria tree:
- Width: the number of sections (first level of the tree, root's children) should be between 3 and 7 (not counting the generic section)
- Depth: the depth of the tree should not exceed 4
- Balance: the leaves should be the most equally balanced as possible
- Avoid criteria containing only one sub criterion
Rules for includes:
- Width: the number of nodes (first level of the tree, root's children) should be between 2 and 5
- Depth: the depth of the tree should not exceed 2

Do not hesitate to fill the comment tags/fields: it will increase the evaluation's value
Each comment (if field is used) should be short, clear and understable, and should explain the score
Collaborate: don't fill your sheets alone, get help, ask for reviews and contributions

Tree infomations are stored in the XML content of the sheet. We use them to create the sheet name:

The name is created like this:

qsosappname-release_language.qsos

For instance:

otrs-2_fr.qsos

If the language is english we ignore the language part of the name:

qsosappname-release.qsos

The full application name is stored in the <appname> entry in the sheet.