Code Development and Testing Process

Issues are periodically logged on our issue tracker.

These issues are compiled into sets to be fixed in the next release.

When working on the next release, work on the development branch for it : for example: 1.1-dev

When you are ready to check in code:

1. Run devtools::test(). This will test that your local outputs look as expected. Review the outputs in the test window, and confirm or deny, make fixes to code.

   Some (or most?) of the tests are comparisons of sample test plots against stored snapshots of the same plots generated on some previous date. These use the vdiffr package, which allows you to step through any plots that have differences.

2. Run devtools::check(). This will check more things in your code, for example library conflicts, or documentation problems. Once you have fixed things, you are ready for:

3. pkgdown::build_site_github_pages(). This will be the code and the documentation. Then push to github on the branch where you are working.

When we are ready to pull the changes into the main branch, do a pull request to the person who you think is in best position to review the code. That person will review the code changes and re-run steps 1-3. Once they are happy with the changes, they are ready to

Merge the pull request into the main branch. Then the development branch can be deleted.

A new development branch should be made at that time.