Mantid Imaging's (MI) externally facing developer documentation surrounding system testing does not go into any particular depth which could be seen as bot being inclusive of introducing the larger open source community to the repository or new starters within the team.
We should improve documentation surrounding usage of MI's tests and checks accessible within our Makefile and how to modify them for certain circumstances such as adding delays to screenshot tests.
Plan, discuss and finally update MI's developer documentation surrounding system testing and static analysis checks to be more inclusive for users who are new to MI.
Examples of commands within Mantid Imaging's makefile which should be documented more including how to modify them to achieve certain results are listed below:
Mantid Imaging's (MI) externally facing developer documentation surrounding system testing does not go into any particular depth which could be seen as bot being inclusive of introducing the larger open source community to the repository or new starters within the team.
We should improve documentation surrounding usage of MI's tests and checks accessible within our
Makefileand how to modify them for certain circumstances such as adding delays to screenshot tests.Plan, discuss and finally update MI's developer documentation surrounding system testing and static analysis checks to be more inclusive for users who are new to MI.
Examples of commands within Mantid Imaging's
makefilewhich should be documented more including how to modify them to achieve certain results are listed below:testtest-verbosetest-systemtest-screenshotstest-screenshots-winmypyyapfruffcheck