docs: CONTRIBUTING.md accuracy pass — verified against every line of code#244
Merged
Conversation
…code Fixes all verified inaccuracies found by comparing every claim in CONTRIBUTING.md against the actual codebase. Changes: - MySQL → Postgres (3 places: prereqs, setup description, crate list) - Port :3306 → :5432 - Clone URL: sprout-rs/sprout → block/sprout - sqlx-cli → pgschema (declarative schema tool) - Added MinIO (:9000) and Prometheus (:9090) to setup description - Added 3 missing crates: sprout-sdk, sprout-media, sprout-cli - Added 3 missing E2E test files: e2e_nostr_interop, e2e_media, e2e_media_extended - API handler example: AuthenticatedUser → extract_auth_context pattern - API handler example: added scope check, check_channel_membership, no unwrap() - Error handling: ApiError → api_error()/internal_error() helpers - Event kind guide: added required_scope_for_kind() step in ingest.rs - Event kind guide: clarified handle_side_effects() is post-storage - MCP tool guide: documented read (REST) vs write (signed event) pattern
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
CONTRIBUTING.md was last updated in PR #40 (Mar 12) — before the MySQL → Postgres migration (#114, Mar 19). PR #220 identified the database references but was closed without merging. Meanwhile, a docs accuracy blitz landed today (#233, #235, #236, #237, #240) fixing every other top-level doc — CONTRIBUTING.md was explicitly called out as the remaining gap.
This PR brings CONTRIBUTING.md to the same standard: every factual claim verified against the actual codebase.
What changed
1 file · +61 / −34
Infrastructure fixes
docker-compose.yml,Cargo.tomlsqlx features,schema/schema.sql:3306:5432docker-compose.ymlsprout-rs/sproutblock/sproutgit remote -vsqlx-cli— "falls back todocker exec"pgschema— "appliesschema/schema.sqldeclaratively"justfile,scripts/dev-setup.sh:9000, +Prometheus:9090)docker-compose.ymlCrate & test list completeness
sprout-sdk, +sprout-media, +sprout-cli)Cargo.tomlworkspace memberse2e_nostr_interop, +e2e_media, +e2e_media_extended)ls crates/sprout-test-client/tests/Code example accuracy
AuthenticatedUserextractor,ApiErrortype,Path<Uuid>,unwrap()extract_auth_context→scope_error→check_token_channel_access→check_channel_access,Path<String>with explicit UUID parse,json!()macroApiErrorinerror.rs"api_error()/internal_error()helpers inapi/mod.rs"handle_side_effectsonlyrequired_scope_for_kind()iningest.rs, fixedhandle_side_effectsarg order to(event, state)self.client.get()) vs write (self.client.send_event()) noteCleanup
#[tool_router]descriptionVerification
Three rounds of crossfire review (Claude Opus + Codex CLI), each round finding and fixing real issues:
pubkeytype mismatch,unwrap(), MCP dual-transport, event-kind dispatch, scope checkside_effectsarg order,check_token_channel_access,scope_error, naming consistency, redundant sentencePath<String>pattern,pubkey_bytescloneAll pre-push hooks pass:
cargo fmt,cargo clippy -D warnings, unit tests (93 passed), desktop build, Tauri check.