Skip to content

Phase 18: Library API analysis & design (design-only) #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cemililik wants to merge 2 commits into from
Closed

Phase 18: Library API analysis & design (design-only) #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7a1f06
docs(phase-18): library API analysis & design
cemililik May 2, 2026
93fd9ad
docs(phase-18): address review-bot + reviewer findings
cemililik May 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ All notable changes to ForgeLM are documented here.
> Per-PR CHANGELOG entries below collapse into the v0.5.5 release
> notes at tag time.

### Added — Wave 2a / Phase 18 — Library API design

- **Library API analysis & design document** —
`docs/analysis/code_reviews/library-api-design-202605021414.md` is the
Phase 18 deliverable: 12 sections + 16-row task plan that pin the public
Python surface for downstream consumers. Resolves the stable / experimental /
internal tier split; documents the lazy-import invariant
(`import forgelm` does not pull `torch`); enumerates the new public symbols
(`audit_dataset`, `verify_audit_log`, `AuditLogger`, `VerifyResult`,
`AuditReport`, `WebhookNotifier`, `detect_pii` / `mask_pii` / `detect_secrets` /
`mask_secrets` / `compute_simhash`); spells out the `py.typed` + `mypy --strict`
contract for the public surface; resolves the Wave 1 round-5 carry-over
(lazy `__getattr__` migration for `forgelm/cli/__init__.py`); specifies the
`tests/test_library_api.py` integration suite Phase 19 must ship. No code
Comment thread
sourcery-ai[bot] marked this conversation as resolved.
changes in this PR — design only; Phase 19 implements.

### Added — Wave 1 closure (Faz 9, 11, 12, 13, 25, 31, 32 — see PR description)

- **Article 14 staging directory + `forgelm approve` / `forgelm reject` (Faz 9)** —
Expand Down
Loading