Skip to content

docs: describe CI jobs accurately in CONTRIBUTING.md #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
collinsezedike merged 3 commits into from
Aug 18, 2026
Merged

docs: describe CI jobs accurately in CONTRIBUTING.md #98

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e33538
docs: describe CI jobs accurately in CONTRIBUTING.md
CepherXx Aug 17, 2026
7d0579c
fix: restore indentation and closing code fence
CepherXx Aug 18, 2026
7ae31d4
fix: correct wasm build step order and fence formatting
CepherXx Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,13 @@ tools/
scripts/
testnet-smoke.sh End-to-end check against real Stellar testnet infrastructure
.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

@collinsezedike collinsezedike Aug 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

committed contract addresses, verifies workspace
membership, fmt, shellcheck, both wasm builds,
clippy, and tests), `demo` (lint and build

@collinsezedike collinsezedike Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@collinsezedike collinsezedike Aug 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


Additional demo apps should each live as their own directory under `demos/`,
following the same layout as `demos/freelance-escrow`.
Expand Down Expand Up @@ -213,7 +218,7 @@ changes in a single message; split them into separate commits instead.

## Opening a PR

CI (fmt, clippy, tests, wasm build) must pass before merge. The PR template
CI must pass before merge: the `test` job (contract-address and workspace-membership checks, fmt, shellcheck, both wasm builds, clippy, tests), the `demo` job (lint and build demos/freelance-escrow), and the `sdk` job (bindings-drift check and build for packages/tholos-sdk). The PR template
(`.github/pull_request_template.md`) is pre-filled when you open a PR; fill it out
rather than deleting it. If the change affects bond amounts, resolver behavior, or
anything with an economic consequence, say so explicitly in the summary so it's easy
Expand Down
Loading