As we add more and more features to ucc-bench, including benchmarking workflows that aren't as narrowly tied to ucc development, it is worth considering improvements to ensure a robust, maintainable and production-ready project. For now, this issue is a placeholder with a checklist, but future work could consider making sub-issues to track individual work.
- Establish a release process, including automation and whether to publish a package
- Add pre-commit hooks for linting/formatting
- Add type checking (and add to CI)
- Add standalone documentation. Migrate much of existing details in README.md to this spot. Add workflow for building docs
- Add automated test coverage checks and get to high-% coverage
- Add clearer contributor guidlines
As we add more and more features to
ucc-bench, including benchmarking workflows that aren't as narrowly tied touccdevelopment, it is worth considering improvements to ensure a robust, maintainable and production-ready project. For now, this issue is a placeholder with a checklist, but future work could consider making sub-issues to track individual work.