Definition of Done bepalen

[fleur-van-alphen-wb]

Eisen stellen aan issues. Dit bepaalt wanneer een issue is opgelost.

[fleur-van-alphen-wb]

• Tests included
• documentation included
• Define minimal coverage
• Docstrings available
• Example available as notebook
• reviewed

[frank-klein-schaarsberg-wb]

• is gecontroleerd door andere developer
• heeft geen oude functionaliteiten stuk gemaakt (althans niet zonder een deprecation warning)
• functionaliteit is getest via pipeline
• pipeline succeeded --> die moet dan ingericht zijn zodat getoetst wordt op docstrings, black, pytests, etc
• changelog updaten (mits van toepassing)
• readme updaten (mits van toepassing)
• example notebook (als aanpassing voor gebruiker relevant is)

[frank-klein-schaarsberg-wb]

Always

• approved in peer review (to discuss: may the review be done by a peer from the same institute)
• CI/CD pipeline succeeded, which should check:
  • docstrings (format numpydoc?)
  • code format (black, CamelCase vs snake_case, etc)
  • unit and functionality tests
  • example notebooks
• CI/CD pipeline of OpenTNSim succeeded

When applicable

• example as Jupyter Notebook (applicable if the increment concerns UI)
• update readme
• update changelog (bug fix, new features, optimizations, deprecations, updates related to UI)