Milestones
List view
1. GitHub actions workflow for continuous integration Make sure the workflow in .github/workflows/build.yml is correctly configured so that at a minimum, it runs the test suite and style checkers on pushes and pull requests to your project’s repository’s deployment branch. A couple things you might need to change in your .github/workflows/build.yml file: - Ensure the deployment branch (typically the main branch) is correctly specified on lines 7 & 10 - Ensure that the correct Python version is listed 2. GitHub actions workflow for continuous deployment Make sure the workflow in .github/workflows/deploy.yml is correctly configured so it runs the test suite, style checkers and deplys to package to test PyPI on pushes to your project’s repository’s deployment branch (typically the main branch). At time of submission, we expect that your project successfully runs this workflow. A couple things you might need to change in your .github/workflows/deploy.yml file: - Ensure the deployment branch (typically the main branch) is correctly specified on lines 7 - Ensure that the correct Python version is listed on line 14 (it should match the version in your pyproject.toml file) 3. Documentation Your package documentation should be very clear by the end of this milestone and deployed using quartodoc on Github Pages in your repository. All docstrings for all functions should be readable by quartodoc. Your documentation should also include a demonstration of how to use each function in the package, so that any user with minimal Python expertise would be able to run your package functions and play around with them.
Due by January 24, 2026•8/8 issues closedTBA
Due by January 17, 2026•8/8 issues closedMilestone 1 summary: - Draft a team work contract - Choose a topic for your software package - Create project structure for the software package - Write function specifications and documentation - Manage issues professionally
Due by January 10, 2026•8/8 issues closed