Developers

Development

This page contains some notes that might be helpful if you want to extend TimTam, if you just want to use the package, the tutorials or installation instructions are probably more helpful.

Roadmap

This page describes (a roughly ordered list of) big picture goals. More detailed material may be found in the issue tracker.

1. Get TimTam onto CBAN!
2. Upgrade to BEAST2.7
3. Extend TimTam to model multiple roots

Class diagram

Releases

Package

Please try to follow the steps listed below:

1. Implement the new feature on dev.
   • Create an issue on GitHub clearly explaining the goal
   • Use IntelliJ IDEA, it’s the simplest solution
2. Create a candidate branch off of main.
3. Merge dev into candidate and check that the result is satisfactory:
   • All tests are passing and any new features have a test.
   • The version number uses semantic versioning.
   • If there have been big changes, check the tutorials work
4. Merge candidate into main and delete candidate.
5. Create and add a new release to GitHub.
   • ant build
6. Update the package XML file

Documentation

Always remember to spell check!