Releases: UBC-MDS/DSCI_524_FileJanitor
milestone4
Milestone 4: Finalizing Work
This release captures the state of the repository at the time of submission for grading purposes.
It includes:
- Polishing source code and documentation
- Discussing and reviewing the license choice
- Finalizing work based on TA and peer review
This release serves as the final tested and usable version of our project; it marks the end of development of FileJanitor.
milestone3
Milestone 3: CICD
This release captures the state of the repository at the time of submission for grading purposes.
It includes:
- Implemented new unit tests
- Updated readme
- Added workflows for continuous deployment and integration
- Set up github pages
This release serves as a tested and usable checkpoint; development will continue for subsequent milestones.
milestone2
Milestone 2: Function Implementations & Unit Tests
This release captures the state of the repository at the time of submission for grading purposes.
It includes:
- Implemented function internals (replace_pattern, standardize_filename, index_files, flatten)
- Unit tests for each function using pytest, covering edge cases and branches
- Exception handling with corresponding tests
- Updated function and test documentation
- GitHub Flow–based development with issues, branches, and pull requests
This release serves as a tested and usable checkpoint; development will continue for subsequent milestones.
0.0.1
Milestone 1: Project Setup & Function Specifications
This release captures the state of the repository at the time of submission for grading purposes.
It includes:
- README.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- Function specifications with complete docstrings (replace_pattern, standardize_filename, index_files, flatten)
- pyproject.toml
- LICENSE.md
This release serves as a checkpoint; development will continue for subsequent milestones.