Home

Welcome to the EzTao wiki!

Workflow for Adding New Features (or bug fixes)

1. Checkout a new branch
2. Start with the '00_template' notebook in the dev folder; must add the current commit hash
3. Develop within the notebook (if possible)
4. Update the code base with the new feature
5. Add/Update tests (if needed)
6. Add/Update documentation (if needed)
7. Run tests locally to make sure everything works
8. Push branch to remote and create a new pull request
9. Merge

Workflow for new release

1. Checkout a new branch (name it with the new version number)
2. Update the 'pyproject.toml' to the new version number
3. Update changelog
4. Update 'docs/requirement.txt' and 'environment.yml' (for mybinder)
5. Push branch to remote and create a new pull request
6. Merge
7. Update mybinder link in readme
8. Add/push version tag
9. Create a new release
10. Click the mybinder link to build image