List view
### **Description:** This milestone focuses on addressing several critical issues to improve the project's quality and streamline its CI/CD pipeline. It includes configuring `pre-commit`, setting up CI workflows, ensuring proper `pyproject.toml` settings, adding necessary documentation, and achieving high test coverage. **Goals:** 1. **Add Pre-commit Configuration**: - Create a `.pre-commit-config.yaml` file for local and CI pre-commit hooks. - Ensure pre-commit hooks are applied to code before commits to maintain code quality. 2. **Set Up CI/CD Workflows**: - Configure GitHub Actions to run tests and publish the package automatically. - Include steps for installing dependencies, running tests with coverage checks, and publishing the package to a repository. 3. **Update `pyproject.toml` Configuration**: - Review and update the `pyproject.toml` file to ensure all necessary configurations are included for build tools, dependencies, and package metadata. 4. **Create Documentation Folder for ReadTheDocs**: - Set up a `docs` folder with appropriate `.rst` files for generating documentation on ReadTheDocs. - Ensure documentation is comprehensive and includes usage instructions, API references, and examples. 5. **Implement Comprehensive `pytest` Suite and Achieve 90%+ Coverage**: - Write unit and integration tests using `pytest`. - Configure `pytest-cov` to report coverage and set a target of 90% or higher. - Integrate `pytest` into the CI pipeline and ensure coverage metrics are tracked. **Tasks:** - [ ] **Pre-commit Configuration**: - Create and configure `.pre-commit-config.yaml`. - Test pre-commit hooks locally and in CI. - [ ] **CI/CD Configuration**: - Set up GitHub Actions workflows for testing and publishing. - Ensure CI pipelines run tests, check coverage, and deploy the package. - [ ] **`pyproject.toml` Configuration**: - Review and update `pyproject.toml` to include necessary settings for the package. - [ ] **Documentation Setup**: - Create `docs` folder and add `.rst` files for ReadTheDocs. - Ensure documentation covers all aspects of the package and is up to date. - [ ] **Testing and Coverage**: - Implement `pytest` tests for the package. - Configure coverage reporting and set a target of 90% or higher. - Integrate coverage tracking into CI and update documentation with coverage status. **Success Criteria:** - **Pre-commit Hooks**: Pre-commit hooks are correctly configured and applied in both local and CI environments. - **CI/CD Workflows**: CI pipelines are set up to run tests, check coverage, and publish the package successfully. - **`pyproject.toml`**: The `pyproject.toml` file is complete and correctly configured for the project. - **Documentation**: Documentation is available on ReadTheDocs and is comprehensive and accurate. - **Testing and Coverage**: A full suite of `pytest` tests is implemented, coverage is 90% or higher, and results are tracked and reported.
Overdue by 9 month(s)•Due by September 30, 2024•9/9 issues closed