docs(profile): add viz + Get started install commands#1
Conversation
- Ecosystem table: add `viz` (C# .NET visualization library) - Update `crates` description to mention the `resq` binary it ships - Update `dev` description to mention the canonical git hooks contract - New "Get started" section: two-curl onboarding (install-resq.sh + install-hooks.sh) so first-time contributors land on a working setup without having to dig through repo-level READMEs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe ecosystem section of the profile README was updated to clarify that the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the repository ecosystem table in profile/README.md by adding the viz repository and refining descriptions for crates and dev. It also introduces a 'Get started' section with installation instructions. Review feedback highlights an inconsistency between this table and the root README.md and suggests using bash instead of sh for executing remote scripts to ensure compatibility with Bash-specific features.
| | [crates](https://github.com/resq-software/crates) | Rust CLI/TUI toolset for drone ops (ships the `resq` binary) | Rust | | ||
| | [pypi](https://github.com/resq-software/pypi) | FastMCP server + DSA utilities | Python | | ||
| | [dotnet-sdk](https://github.com/resq-software/dotnet-sdk) | .NET typed clients + blockchain anchoring | C# | | ||
| | [programs](https://github.com/resq-software/programs) | Solana Anchor on-chain programs | Rust | | ||
| | [vcpkg](https://github.com/resq-software/vcpkg) | C++ vcpkg libraries | C++ | | ||
| | [viz](https://github.com/resq-software/viz) | .NET visualization library | C# | | ||
| | [landing](https://github.com/resq-software/landing) | Marketing & product site | Next.js | | ||
| | [docs](https://github.com/resq-software/docs) | Documentation (Mintlify) | MDX | | ||
| | [dev](https://github.com/resq-software/dev) | One-command developer setup | Shell | | ||
| | [dev](https://github.com/resq-software/dev) | One-command developer setup + canonical git hooks | Shell | |
There was a problem hiding this comment.
The ecosystem table in this file is inconsistent with the one in the root README.md (lines 54-64). Specifically:
- Repository names and links differ (e.g.,
cratesvscli,npmvsui,pypivsmcp). - The new
vizrepository is missing from the rootREADME.md. - Descriptions for
devandcrateshave been updated here but not in the root file.
Consider synchronizing both tables to ensure a consistent experience for users browsing the organization.
| curl -fsSL https://raw.githubusercontent.com/resq-software/dev/main/scripts/install-resq.sh | sh | ||
| cd <any resq repo> | ||
| curl -fsSL https://raw.githubusercontent.com/resq-software/dev/main/scripts/install-hooks.sh | sh |
There was a problem hiding this comment.
It is recommended to use bash instead of sh when piping remote scripts to the shell. Many modern installation scripts rely on Bash-specific features (like pipefail, arrays, or extended globbing) that are not available in POSIX-compliant shells like dash (the default sh on many Linux distributions).
| curl -fsSL https://raw.githubusercontent.com/resq-software/dev/main/scripts/install-resq.sh | sh | |
| cd <any resq repo> | |
| curl -fsSL https://raw.githubusercontent.com/resq-software/dev/main/scripts/install-hooks.sh | sh | |
| curl -fsSL https://raw.githubusercontent.com/resq-software/dev/main/scripts/install-resq.sh | bash | |
| cd <any resq repo> | |
| curl -fsSL https://raw.githubusercontent.com/resq-software/dev/main/scripts/install-hooks.sh | bash |
…e lang Addresses review feedback on PR #12 from CodeQL, CodeRabbit, and gemini-code-assist: Script-injection mitigations (CodeQL #1-15, #22-25; CodeRabbit): - node-ci.yml: forward install/lint/typecheck/build/test/package-manager via env: - python-ci.yml: forward ruff/mypy/test targets and flags via env: - rust-ci.yml: forward clippy-flags and test-flags via env: - cpp-ci.yml: forward source-dir, build-dir, cmake-flags via env: - docker-publish.yml: image-digest output doc-fixed (only populated when push:true) All affected steps now use `sh -c "$VAR"` rather than direct `${{ ... }}` interpolation, closing the template-time-to-shell expansion path. node-ci.yml critical ordering fix (CodeRabbit): - pnpm/action-setup now runs BEFORE actions/setup-node with cache: 'pnpm'; required because setup-node's pnpm cache detection resolves the pnpm binary. required.yml (CodeRabbit): - Added validate-lang gate that fails fast on unknown lang values. Prior to this, a typo like `pyhton` silently skipped every language job and `required` still passed. validate-lang is now a `needs:` dependency of every other job + the final `required` evaluator. python-ci.yml (CodeRabbit): - Added `test-paths` input (default empty = pytest discovers via pyproject.toml). Previous hardcoded `tests/` didn't match src-layout or discover-by-config projects. ops/governance-payloads.md (gemini-code-assist): - Rollback command for rulesets: PUT was stripping the resource because only `enforcement` was sent. Replaced with `gh api GET | jq .enforcement="disabled" | gh api PUT --input -`. Still open (not fixed here, requires org discussion): - Ruleset A `required_approving_review_count: 0` — gemini notes that without CODEOWNERS matching, PRs can merge with zero reviews. Current solo-dev intent; bump when team grows.
1 participant
Summary
Two small updates to the org profile README shown on https://github.com/resq-software:
Ecosystem table
viz(.NET visualization library) — was missingcratesships theresqbinary (the hook/audit backend)devships the canonical git hooks contractNew "Get started" section
Two-curl onboarding using the installers that just landed in
dev/:scripts/install-resq.sh— SHA-verified binary from the latestresq-cli-v*release, cargo fallbackscripts/install-hooks.sh— canonical hooks + prompt to scaffold a repo-type-awarelocal-pre-pushKeeps the current compact style.
🤖 Generated with Claude Code
Summary by CodeRabbit