Quality Assurance and Project Standard

For the purpose of making our work more effecient we enforce few rules in the aspects of coding, managing and tracing back our work. This is part of the Project Standard and Quality Assurance of the project and must follow these rules.

The rules

In the aspect of coding:

• NO @Ignore on single tests.
• Using library iz/az/lisp/step/extract
• No commented out code (including Tippers in the Toolbox, an issue instead)
• Apply spartanization on itself.
• Cleanup and Format the project.

In the aspect of managing the project:

• Suppress only on bugs with issues.
• Whenever the spartanizer fails on project:
  • An issue is created, with correct labels/milestones/etc.
  • An issue test class is created, with at least one test.
  • This class is marked @Ignore
  • You use @orimarco code for creating tests.

In the aspect of tracing back and solving bugs more effeciently:

• Link to classes that create tests.
• One sentence doc to each new class that explains it's purpose.
• In each test class add a link to the tested tipper (or naything else tested),
  for example /** This is a unit test for {@link SomeRandomTipper} */
• For each tipper and any other class, mention as part of the documentation the Issue it solves and add a link to the testing classes (including test classes created when solving bugs).
  for example /** Testing classes for this tipper are {@link Issue354}, {@link Issue487} */
• @author and @since for each new class.