Definition of DONE - Integrative-Transcriptomics/tss-prediction-comparison GitHub Wiki

General defintions

  • PO accepts the task and move from review to done
  • Test for compatibility (one function does not crash the rest)
  • Module-wise testing, not independent functions
    • Code coverage at least 80% (pending for discussion)
  • Reviewed at least by one person before merging
  • Code and file structure is well-documented

Documentation

Internal documentation

  • Clear function and variable naming

  • Coding Standards of Python and JS

    • JS: camelCase for functions and variables
    • Python: has_other_standards
    • Constants are ALL_CAPS

External documentation

  • Users: Readme for user as an introduction for Tool

  • Developers: Readme stating what each script is doing to provide an overview in the file structure

  • Content: The Wiki should also provide a collection of important information relevant for the following weeks. Each entry should be proofread by at least two other members of the team, to ensure that the information is concise and correct.