Skip to content
cccskills
FreePublished on GitHub

contributor-onboarding

Check a local Codewhale checkout before contributing: inspect branch and sync status, build the CLI, and run the repository’s CI checks. Present recent commits and changelog entries from local files, with clear status for each step.

OriginalShow the original description

Help a new contributor get productive on this checkout - inspect sync state against main, build, run the repository's exact verification gate, and produce a local what's-new digest. Never fetches, pulls, or modifies a dirty tree on its own. Explicit-only.

See how to install

Good for

  • Checking a checkout before contributing
  • Reviewing local changes and sync status
  • Running the build and CI verification commands
  • Reading recent commits and released changes

Files included (1)

  • SKILL.md4.9 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Contributor Onboarding

A first-run path for a contributor who has cloned the repo and wants to know am I current, does it build, does it pass, and what changed while I was away — without a wall of prose and without anything touching their working tree behind their back.

Invocation

Explicit-only. Loading this skill is not authority to fetch, pull, rebase, push, or write files. Every network or mutating step below is a separate action the contributor must ask for after reading the plan.

Non-goals

  • Do not run git fetch, git pull, git rebase, or git checkout on your own initiative. Report state; propose the command; wait.
  • Do not stash, discard, reset, or commit a dirty tree. Ever.
  • Do not call a model provider. Every step here is a local command with a deterministic result. The digest is built from files and git output, not generated prose.
  • Do not claim a gate passed that you did not run, and do not summarize a build you did not observe.
  • Do not privilege any provider. Codewhale is provider-neutral; a dogfood run uses whatever route the contributor already configured, or none.

Workflow

1. Inspect (read-only, always safe)

Run these and report the results verbatim. Nothing here writes:

git rev-parse --abbrev-ref HEAD
git status --porcelain
git rev-list --left-right --count origin/main...HEAD

Report three facts plainly:

  • Branch the contributor is on.
  • Tree state: clean, or the count and paths of dirty entries.
  • Sync state: N behind, M ahead of origin/main, or unavailable when origin/main is missing or has never been fetched. Unavailable is a real answer — say it rather than guessing zero.

2. Sync — propose, never perform

If behind, print the exact commands and stop:

git fetch origin
git rebase origin/main     # or: git merge origin/main

If the tree is dirty, do not propose a sync at all. Print a recovery plan first, in this order, and let the contributor choose:

  1. git stash push -u -m "wip before sync" then sync, then git stash pop
  2. Commit the work on a branch, then sync
  3. Stay behind and continue — being behind is not an error

3. Build

cargo build --release -p codewhale-cli --bin codewhale

Report the exit status and the first error if it fails. A build failure ends the run: do not proceed to the gate and do not report gate results.

4. Verification gate — the repository's exact CI command

Run what CI runs, not a paraphrase of it. Read .github/workflows/ci.yml first and run its Rust steps verbatim; the list below is a snapshot that loses to the workflow when they disagree:

cargo fmt --all -- --check
cargo clippy --workspace --all-targets --all-features --locked -- \
  -D warnings \
  -A clippy::uninlined_format_args \
  -A clippy::too_many_arguments \
  -A clippy::unnecessary_map_or
cargo test --workspace

If the workflow uses flags this snapshot lacks (or vice versa), say so and follow the workflow.

Known suite papercut: run_verifiers_background_* is flaky under full-suite parallelism and passes in isolation. Attribute it to the known flake, not to the contributor's change.

5. What's new — deterministic local digest

Built only from files already on disk. No network, no model:

git log --oneline -n 20 origin/main

plus the topmost released section of CHANGELOG.md.

Rules:

  • Cap the digest at 20 commits and 40 lines of changelog. State the cap when you hit it; do not silently truncate.
  • If origin/main is unavailable, digest HEAD instead and label it as such.
  • Quote what the files say. Do not summarize, rank, or editorialize — the point is that two contributors on the same commit get the same digest.

6. Dogfood — optional, staged, confirmed

Only after the gate has actually passed, and only if the contributor asks. Print the plan and require an explicit yes before running anything:

./target/release/codewhale exec --help

This is a provider-free smoke check: it exercises the built binary without sending a request anywhere. Anything beyond it — an actual codewhale exec turn — needs the contributor's own configured route and their explicit go-ahead. Never select a provider for them and never fall back to a default one.

Reporting

End with a compact status table: branch, tree, sync, build, gate, digest, dogfood. Use not run for anything skipped and unavailable for anything the environment could not determine. Never write passed from inference.

Credit

Requested by @JayBeest (#4227). Preserve that attribution in the changelog entry and in the commit body of any change that lands from this skill.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

batch

FreeSummary

Split a large goal into clearly bounded tasks that can run in parallel. Coordinate existing agent and worktree tools, then combine and verify the results. The skill starts only when explicitly requested.

  • Splitting a large goal into parallel tasks
  • Coordinating work across multiple agents
  • Running tasks in separate worktrees
codewhale-hq/Codewhale41.1KUpdated Oct 19, 2026

best-of-n

FreeSummary

Generate independent options for design, implementation, explanations, or debugging, then compare them using one shared rubric. Code candidates use separate working copies and undergo independent verification before a winner is presented for review.

  • Comparing several plausible design approaches
  • Evaluating independent implementations of the same task
  • Comparing explanations or debugging approaches
codewhale-hq/Codewhale41.1KUpdated Oct 19, 2026

Check Codewhale release readiness through ordered tests, builds, version checks, and manual terminal checks. Record command results and observed behavior, including responsiveness, route isolation, and follow-up input handling, while explicitly identifying any skipped checks.

  • Run automated checks on the actual release branch
  • Check whether a PR merges into the release branch
  • Manually test terminal responsiveness and input behavior
codewhale-hq/Codewhale41.1KUpdated Oct 19, 2026

computer-use

FreeSummary

Operate desktop apps and isolated browsers on registered computers by inspecting interface controls, entering information, and checking results. The skill also covers screenshots and recording, with separate routing for the user's signed-in Chrome through Chromewhale.

  • Entering information through a desktop app interface
  • Working in an isolated browser session
  • Capturing screenshots or recordings for a task
codewhale-hq/Codewhale41.1KUpdated Oct 19, 2026

cw-dogfood

FreeSummary

Builds and installs Codewhale with a source revision identifier, then verifies the installed version in a fresh shell. It guides hands-on runtime checks for interface behavior, routing, approvals, and other changes that automated tests may miss.

  • Verifying terminal interface changes in the actual product
  • Installing and checking a local release build
  • Checking model routing and approval behavior
codewhale-hq/Codewhale41.1KUpdated Oct 19, 2026

cw-gates

FreeSummary

Verify Codewhale changes with checks matched to their scope and risk. Collect actual test counts, automated limit checks, and command output to show what passed, what failed, and what remains unverified.

  • Verify a fix before marking it complete
  • Choose tests for the changed area
  • Check limits and consistency rules enforced by CI
codewhale-hq/Codewhale41.1KUpdated Oct 19, 2026

See all skills by codewhale-hq

Report a problem with this skill