Skip to content

[Chore] README.md understates what CI actually gates #101

Description

@collinsezedike

Summary

README.md describes CI the same way CONTRIBUTING.md used to before #96/#98 fixed it. The tech-stack table (line 58) says CI is just "cargo fmt, shellcheck, cargo clippy, cargo test, wasm build", and the project-layout tree (line 74) says ci.yml "Runs fmt, clippy, tests, and the wasm build on every push/PR". Neither mentions the committed-contract-address check, the workspace-membership check, the second workspace-wide lib wasm build, or the separate demo and sdk jobs.

Scope

  • Update the tech-stack table's CI row (line 58) to reflect the actual three-job pipeline.
  • Update the project-layout tree's ci.yml entry (line 74) to match.
  • Docs-only change; no code or CI behavior changes.

Proposed approach

Read .github/workflows/ci.yml job by job, same as #96 did for CONTRIBUTING.md, and describe each job accurately and concisely rather than restating the current one-liner. The updated CONTRIBUTING.md wording (from #96/#98) is a good reference for phrasing, but keep the README's version shorter given it's a summary table, not the contribution guide.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions