Committing to Daysim

Steps to Commit a Change to Daysim

1. Create an issue describing the problem/issue/bug
2. If you don't have write access to the repo, then first fork the repo and work in the fork.
3. Commit all changes for the issue to a new branch, named something related to the problem/issue/bug, for example trip-mode-fix
4. When ready to add these into Daysim proper, commit the changes to the develop branch. If working in a fork, then issue a pull request for us to review.
5. A commit to the develop branch automatically runs the test system
6. If pass, then the test system merges develop into master. Close the issue if applicable.
7. If fail, then correct and re-commit to develop.

Note that the master branch is write protected and can only be written to by the DaySim-Jenkins-user by Jenkins after the tests pass.

Updating the Expected Regression Data

If you know that the change is correct, and that the tests need to be updated, then you can update the expected test data as follows:

1. Run the test, which will fail, but will produce new output files. The new output files are in the regression_results_<date> / regress_outputs and regress_working folders.
2. Replace the regress_outputs and regress_working folders in the repo with these new files.
3. Delete all the regression_results_<date> folders.
4. Re-run the test.
5. If the test passes, commit and push the new regress_outputs and regress_working folders.