Skip to content

Release 3.6.1: document the 3.6.0 API in README + coverage/dartdoc/README house rules#21

Merged
dipu-bd merged 1 commit into
masterfrom
claude/release-3.6.1
Jul 22, 2026
Merged

Release 3.6.1: document the 3.6.0 API in README + coverage/dartdoc/README house rules#21
dipu-bd merged 1 commit into
masterfrom
claude/release-3.6.1

Conversation

@dipu-bd

@dipu-bd dipu-bd commented Jul 22, 2026

Copy link
Copy Markdown
Member

A docs-only 3.6.1 patch: the README predated the 3.6.0 API. No library code changes.

README (3.6.1)

  • New "Bytes, non-throwing decode, and constant-time compare" section documenting the to<Name>Bytes byte encoders, the non-throwing tryFrom<Name> decoders, constantTimeEquals, and the exported converter base classes (BitEncoder/ByteEncoder/AlphabetEncoder + decoders).
  • Noted that Crockford Base-32 decoding is case-insensitive and maps I/i/L/l1, O/o0.
  • Added a Highlights bullet; refreshed the install snippet to ^3.6.1.
  • pubspec.yaml bumped to 3.6.1; CHANGELOG entry added (pubspec == changelog heading).

New AGENTS.md house rules

  • Always update README.md in the same commit as any public-API change (new to/from/try function, codec, alphabet, or exported class) — a stale README is a release defect.
  • 100% line coverage and 100% dartdoc are hard gates — new code ships with the tests covering all its branches and dartdoc on every public symbol; run scripts/coverage.sh before committing (CI has no coverage gate).

Verified: version == changelog heading, dart format clean, dart analyze --fatal-infos clean, dart test green on vm and node (663 / 658), integration smoke test OK.


Not done here (your call): tagging v3.6.1 and publishing. Merge this, then tag master — pubspec already reads 3.6.1.


Generated by Claude Code

The README predated the 3.6.0 API. Add a "Bytes, non-throwing decode, and
constant-time compare" section covering the `to<Name>Bytes` byte encoders, the
non-throwing `tryFrom<Name>` decoders, `constantTimeEquals`, and the exported
converter base classes; note the case-insensitive Crockford decoding; refresh
the install snippet; and bump `pubspec.yaml` + CHANGELOG to 3.6.1 (docs-only, no
library change).

Also add two AGENTS.md conventions: always update `README.md` in the same commit
as a public-API change, and treat 100% line coverage and 100% dartdoc as hard
gates on every commit.
@dipu-bd
dipu-bd force-pushed the claude/release-3.6.1 branch from e8de492 to d29222b Compare July 22, 2026 18:10
@dipu-bd
dipu-bd merged commit e847c0c into master Jul 22, 2026
18 checks passed
@dipu-bd
dipu-bd deleted the claude/release-3.6.1 branch July 22, 2026 18:13
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants