Skip to content

[Docs] contracts/fuzz_invariants.md is not linked from contracts/README.md #1505

Description

@grantfox-oss

Join our community: https://t.me/+DOylgFv1jyJlNzM0

Why this matters
contracts/fuzz_invariants.md documents the invariants each fuzz target checks, but contracts/README.md never references it, so contributors setting up fuzzing via contracts/FUZZING_README.md and contracts/fuzz_campaign.sh have no obvious path to find it.

Acceptance criteria

  • Add a link to fuzz_invariants.md from contracts/README.md
  • Cross-link contracts/FUZZING_README.md and fuzz_invariants.md to each other

Files to touch

  • contracts/README.md
  • contracts/FUZZING_README.md

Out of scope
Adding new invariants.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contractsIssues related to smart contractsdocsDocumentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions