Skip to content

Document missing modules in README's Modules table #240

Description

@N-thnI

Problem

The "Modules" table in README.md only documents 10 of the modules that exist under src/. Missing: src/contracts/* (logic.rs, proxy_entry.rs, rbac.rs, storage_layout.rs), src/utils/* (address.rs), gas.rs, migrate.rs, timelock.rs, consensus.rs.

Why it matters

A new contributor reading the README has no way to know what rbac.rs, proxy_entry.rs, storage_layout.rs, timelock.rs, consensus.rs, or migrate.rs are responsible for without opening and reading the source directly.

Acceptance criteria

  • Add a one-line "Responsibility" description for each currently-undocumented module listed above
  • Keep the existing table format/style
  • Descriptions are accurate to current behavior (read the module before summarizing it, don't guess from the filename)

Scope

README table only. This depends on issue #1 (duplicate table removal) being resolved first — edit whichever copy remains, or coordinate if both are open simultaneously.

Definition of done

Every .rs file under src/ (including src/contracts/ and src/utils/) has a corresponding row in the README "Modules" table with an accurate one-line description.

Activity

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

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions