Skip to content

Guidelines for reviewing code

Lars D'Hondt edited this page Jan 3, 2024 · 3 revisions

Do I understand the changes?

  • Functions and variables have meaningful names.
  • Functions have a header according to the template.
  • The readme is up to date.

Do the changes work?

  • The provided unit test return the expected result. Not all changes require a unit test. Reviewers can ask the contributor to provide a unit test if they think it is needed.
  • Simulations with settings as described in the pull request run without errors.

Do the changes not break the existing code?

  • The changed code can reproduce simulation results for the example model and settings (i.e. main.m from the master branch).