Repository navigation
Update docs for today's merges; add semver and release-process rules - #17
Merged
Merged
Conversation
Documentation: - CHANGELOG.md (and its mirror, docs/changelog.md) now covers the nested-Sequential .h5 loading fix and the Windows/Pillow annotation fixes merged today (PRs #13, #14, #16), not just the DepthwiseConv2D compat fix. - README.md / docs/index.md "Compatibility" sections updated to mention both new fixes. - docs/index.md's table of contents was missing links to the Changelog and Contributing pages despite both being in the mkdocs nav; added, plus a new Releasing page. Versioning/release process: - Added docs/releasing.md: semantic versioning rules (what bumps MAJOR vs MINOR vs PATCH for this package specifically), changelog discipline (add an entry in the same PR as the change), and a step-by-step release checklist (bump version, tag, GitHub Release, which triggers the existing publish.yml to PyPI). Linked from mkdocs.yml's nav and from docs/contribution.md. - Fixed a real version-tracking bug found while writing that doc: src/__init__.py's __version__ said "1.2" while setup.py separately hardcoded "1.3.0" -- neither of which had actually been released (the latest tag is v1.2). setup.py now reads the version from src/__init__.py instead of duplicating it, so there's exactly one place to bump per release. Verified: `python setup.py --version` resolves to 1.3.0 via the new single source of truth, `mkdocs build --strict` succeeds with no warnings, and classify_image.py in the tm-example test project still runs correctly end to end.
Contributor
 |
|
Overall Grade |
Security Reliability Complexity Hygiene |
Code Review Summary
| Analyzer | Status | Updated (UTC) | Details |
|---|---|---|---|
| Python |  |
Sep 12, 2026 6:33p.m. | Review ↗ |
Important
AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation:
Versioning/release process:
Verified:
python setup.py --versionresolves to 1.3.0 via the new single source of truth,mkdocs build --strictsucceeds with no warnings, and classify_image.py in the tm-example test project still runs correctly end to end.