docs: describe CI jobs accurately in CONTRIBUTING.md - #98
Conversation
| .github/workflows/ | ||
| ci.yml Runs fmt, clippy, tests, and the wasm build on every push/PR | ||
| ``` | ||
| ci.yml Runs three jobs on every push/PR: `test` (blocks |
There was a problem hiding this comment.
This drops the two-space indentation every other child entry uses under its parent directory in this tree (e.g. testnet-smoke.sh under scripts/). Once fixed, ci.yml should still read as a child of .github/workflows/, not a sibling.
| clippy, and tests), `demo` (lint and build | ||
| demos/freelance-escrow), and `sdk` (checks | ||
| packages/tholos-sdk's generated bindings for | ||
| drift, then builds it) |
There was a problem hiding this comment.
The closing fence for this code block was deleted and not replaced. Everything from here down through the next fence now renders as one unclosed code block, swallowing headings, prose, and links into plain unformatted text.
|
The PR description is hard-wrapped with CRLF line endings around 72 characters instead of written as flowing paragraphs. That's why it renders left-aligned and rigid instead of as normal markdown prose. Worth fixing when you push the other changes. Write it as normal paragraphs without manual line breaks. |
| ci.yml Runs three jobs on every push/PR: `test` (blocks | ||
| committed contract addresses, verifies workspace | ||
| membership, fmt, shellcheck, both wasm builds, | ||
| clippy, and tests), `demo` (lint and build |
There was a problem hiding this comment.
This still misstates the step order. Only the tholos-only wasm build runs before clippy in ci.yml; the workspace --lib wasm build runs after the test step, not grouped with the first build. Please reword so "both wasm builds" doesn't read as happening together before clippy.
| demos/freelance-escrow), and `sdk` (checks | ||
| packages/tholos-sdk's generated bindings for | ||
| drift, then builds it) | ||
| ``` |
There was a problem hiding this comment.
The closing fence has trailing whitespace and the blank line separating it from the next paragraph got dropped. Please restore the blank line and drop the trailing space.
collinsezedike
left a comment
collinsezedike
left a comment
There was a problem hiding this comment.
Both issues from the last review are fixed. Thanks for the contribution, feel free to pick up another open issue.
2 participants
Closes #96
Summary
CONTRIBUTING.md described CI as only running "fmt, clippy, tests, and the wasm build," but ci.yml actually runs three separate jobs:
test(contract-address check, workspace-membership check, fmt, shellcheck, builds tholos's wasm, clippy, tests, then a second workspace-wide lib wasm build),demo(lint and build demos/freelance-escrow), andsdk(bindings-drift check and build for packages/tholos-sdk). This updates the project-layout table entry and the "Opening a PR" section to accurately describe what's gated. Docs-only change; no code or CI behavior changes.Test plan