Testing Guidelines

  1. Testing the code will follow this format.

  2. Apart from the code some of the documentation is incorrect and needs to be updated with the correct format and proper examples showcasing the right way to use a function. You can refer to this function for an example.

  3. Testing the code does not necessarily have to be extensive, if the underlying implementation relies on another library like OpenCV2 then the actual implementation should be correct but we need to make sure that the code behaves correctly when:

    1. User passes the wrong arguments

    2. User passes no arguments

  4. If the code does not behave correctly for example:

    1. If the return types or input types are incorrect

    2. The actual implementation is wrong

  5. Then, the code changes need to be made to fix them

  6. Some code is difficult to test such as building a model, in these cases a minimal amount of tests are sufficient.