Skip to content

Commit 4577538

Browse files
committed
documented changes addressing peer & TA feedback
1 parent 7fd4ff1 commit 4577538

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

CHANGELOG.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,29 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
98

10-
- Upcoming features and fixes
9+
### Added
10+
11+
- Added clearer, runnable example usage demonstrating all package functions and included a standalone `examples/usage.py` script and `tutorials/usage.qmd` vignette to the docs #64.
12+
- Annotated static test fixtures and mutation tests to make test cases reproducible and easier to review #58.
13+
14+
### Changed
15+
16+
- Fixed incorrect README instruction (`cd sudoku_validation`) and updated README #72.
17+
- Updated documentation to include the API reference pages and linked them from the site landing #64.
18+
- Replaced placeholder contact method with actual contact information #70.
19+
- Fixed Contributing section GitHub usernames #73.
20+
21+
### Fixed
22+
23+
- Adjusted Quarto configuration and documentation pages so the landing page and tutorial render correctly; enabled page TOC and sidebar linking to README sections #64.
24+
25+
26+
### Maintenance
27+
28+
- Closed completed review issues and cleaned up untracked or unnecessary files and ignored temporary files.
29+
30+
### Governance
31+
- Added discussion and reasoning for the license choice #61
1132

12-
## [0.1.0] - (1979-01-01)
1333

14-
- First release

0 commit comments

Comments
 (0)