Chapter 7. How to contribute?

Table of Contents

7.1. JavaDoc comment convention
7.2. Code convention
7.3. Methodology for writing tests
7.4. Adding a test suite
7.5. Submmiting a contribution

Anyone can contribute to the tests according with the follow guideline. Contributions are welcome.

7.1. JavaDoc comment convention

The test classes respect a comment convention that has some custom tags. The custom tags are:

  • @reference - used in class comment. It is used to specify the document that the tests cover.

  • @requirement - used in class comment. It is used to specify the classes and files needed to run the tests.

  • @setup - used in class comment. It is used to specify the items that must be set up before the test execution.

  • @input - used in method comment. It is used to specify the test inputs.

  • @output - used in method comment. It is used to specify the test expected outputs.