Skip to content

Development Management

Oliver Leung edited this page Nov 18, 2018 · 2 revisions
  • Master branch: the master branch should be kept completely functional
    • Approval by other members will be required for merging and pushing to the master branch
    • E.g. Oliver and I will approve each other's subteam's changes
  • Travis tests: we should Travis tests that aren't passing as soon as possible/reasonable
  • Coverage: the goal for coverage is 100%
    • If certain files don't need to be tested via pytests, add a codecov.yml file to the repository to specify the files to ignore
    • Add "smoke tests", or instructions on manual testing, for code that cannot be tested via pytests, such as functions that produce graphics or open new windows
    • Suggested image comparison module
  • Testing methodology: testing functions via examples in docstrings is best for functions users will be interacting with. Otherwise, pytests (in separate files starting with "test") are preferred

Table of Contents

Home

About the Developers

Clone this wiki locally