Skip to content

docs(changelog): move entry-authoring instructions to AGENTS.md - #202

Merged
rayyan224 merged 1 commit into
mainfrom
changelog/followup
Aug 14, 2026
Merged

docs(changelog): move entry-authoring instructions to AGENTS.md#202
rayyan224 merged 1 commit into
mainfrom
changelog/followup

Conversation

@rayyan224

Copy link
Copy Markdown
Collaborator

Summary

  • changelog/README.md now only documents current state: the hardfork ordinals table and the index of shipped/upcoming entries.
  • New changelog/AGENTS.md holds the authoring instructions that used to live in README.md: file-naming rules, entry structure, verification requirements, and how to add a row to the index.

Test plan

  • Docs-only change; no build/test impact.
  • Confirmed all links between README.md and AGENTS.md resolve.

README.md now documents only the current state (ordinals, index of
shipped/upcoming entries). Naming rules, entry structure, and
verification requirements move to changelog/AGENTS.md.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Interface Coverage

✅ All interface functions have test coverage.

@github-actions

Copy link
Copy Markdown

📊 Forge Coverage (src/lib/)

🟡 ≥95% across all metrics — some metrics below 99%.

File Lines Stmts Branches Funcs
🟡 B20FactoryLib.sol 97.70% 98.00% 100.00% 95.00%
🔴 test/lib/ForceFeeder.sol 0.00% 0.00% 100.00% 0.00%
🔴 test/lib/PrecompileProbe.sol 0.00% 0.00% 0.00% 0.00%
🟢 MockActivationRegistry.sol 100.00% 100.00% 100.00% 100.00%
🟢 MockActivationRegistryStorage.sol 100.00% 100.00% 100.00% 100.00%
🟢 MockB20.sol 100.00% 100.00% 100.00% 100.00%
🟢 MockB20Asset.sol 100.00% 100.00% 100.00% 100.00%
🟡 MockB20Factory.sol 98.96% 99.10% 100.00% 100.00%
🟢 MockB20Stablecoin.sol 100.00% 100.00% 100.00% 100.00%
🟢 MockB20Storage.sol 100.00% 100.00% 100.00% 100.00%
🟡 MockPolicyRegistry.sol 100.00% 99.54% 97.67% 100.00%
🟢 MockPolicyRegistryStorage.sol 100.00% 100.00% 100.00% 100.00%
Total 97.07% 97.52% 98.16% 97.00%

Full report: download artifact. To browse locally: make coverage (runs forge coverage + genhtml + opens the HTML report).

@github-actions

Copy link
Copy Markdown

✅ Fork tests: all 721 passed

base/base is fully in sync with the base-std spec.

@stephancill stephancill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should add a note to main agents.md too pointing to this file

@rayyan224
rayyan224 merged commit e30b342 into main Aug 14, 2026
10 checks passed
@rayyan224
rayyan224 deleted the changelog/followup branch August 14, 2026 15:59
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.

2 participants