Skip to content
John Pierce edited this page Nov 22, 2017 · 1 revision

The Kloxo code is poorly documented and lacks unit tests. To improve the quality of the code and make testing easier, please complete the following steps before making code changes.

  1. Does the php file have a Page-level DocBlock? If not please add a DocBlock describing the file.

  2. Does the class have a DocBlock? If not please add a DocBlock describing the class.

  3. Does the class have a Unit Test? If not please create a Unit Test for the class.

  4. Does the function have a DocBlock? If not please add a DocBlock for the function.

  5. Does the function have a Unit Test? If not please create a Unit Test for the function. The unit test should work for the function prior to you making code changes. If the function has an existing bug, please make a test that will detect that the bug has been fixed.

Instructions for adding DocBlocks and creating Unit test are still to come.

Clone this wiki locally