Skip to content

[Chore] CONTRIBUTING.md understates what CI actually gates #96

Description

@collinsezedike

Summary

CONTRIBUTING.md describes CI as only running "fmt, clippy, tests, and the wasm build" (project-layout table, and again in "Opening a PR"). .github/workflows/ci.yml actually gates a lot more than that: a committed-contract-address grep, a workspace-membership check, shellcheck scripts/*.sh, a second lib-only wasm build for the whole workspace, and two entirely separate jobs (demo: lint + build for demos/freelance-escrow; sdk: bindings-drift check + build for packages/tholos-sdk). A contributor reading CONTRIBUTING.md alone would not know any of that has to pass before merge.

Scope

  • Update CONTRIBUTING.md's project-layout table entry for ci.yml (line ~68) and the "Opening a PR" section (line ~216) to actually list what's gated: fmt, shellcheck, the address/workspace checks, clippy, tests, both wasm builds, and the demo/sdk jobs.
  • Docs-only change; no code or CI behavior changes.

Proposed approach

Read .github/workflows/ci.yml job-by-job and describe each one accurately and concisely, rather than restating the current (incomplete) one-liner.

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardThird CampaignCampaign: Third CampaignenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions