docs(contributing): drop stale MCP-tool ToC entry, align just ci docs#2612
Open
SeanGearin wants to merge 1 commit into
Open
docs(contributing): drop stale MCP-tool ToC entry, align just ci docs#2612SeanGearin wants to merge 1 commit into
just ci docs#2612SeanGearin wants to merge 1 commit into
Conversation
Signed-off-by: Sean Gearin <sgearin@gmail.com>
SeanGearin
force-pushed
the
docs-contributing-fixes
branch
from
July 23, 2026 20:20
687875e to
4386203
Compare
wpfleger96
added a commit
that referenced
this pull request
Jul 24, 2026
Apply review feedback from pass 1: - Rewrite 'Before You Open a PR' to lead with contributor benefit (two-minute search saves duplicate work) rather than closure stats; drop the hard four-step permission gate and 'Duplicate-check in your PR template' subsection; soften agent-policy to 'may be closed with a pointer'; issue-first is now a strong recommendation, not a gate - Fix intro to route questions to the new question.yml form instead of a dead 'community channels' link - Restore 'How to Add a New MCP Tool' ToC entry (#2612 owns the section body; this restores the pre-existing entry) - Replace 'within a few business days' review SLA with capacity-honest language - PR template: issue-first wording → recommendation; replace conditional AI checkbox with explicit fill-in field; add conditional integration test item (just ci does not run just test); fix '#' prefix on duplicate field; fix bare 'Fixes #' line - bug-report.yml: point version field to Desktop Settings footer; drop buzz --version (flag does not exist); allow 'unknown' - feature-request.yml: issue-first wording → recommendation - Add question.yml issue form with two required fields (what/tried) and optional environment; links question route end-to-end Co-authored-by: Will Pfleger <pfleger.will@gmail.com> Signed-off-by: Will Pfleger <pfleger.will@gmail.com>
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
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.
Problem
Two verified pieces of contributor-docs drift:
Dead ToC entry. The CONTRIBUTING.md Table of Contents lists
"How to Add a New MCP Tool" (
#how-to-add-a-new-mcp-tool), but no suchsection exists in the body — the body jumps from "How to Add a New Event
Kind" straight to "How to Add a New API Endpoint". The section was
deliberately removed in chore: deprecate sprout-mcp — fill CLI gaps, remove crate and all references #850 ("chore: deprecate sprout-mcp — fill CLI
gaps, remove crate and all references"); the ToC entry was left behind
and now links to a dead anchor.
just cidescribed inconsistently everywhere it is enumerated. TheJustfile recipe (line 258) actually runs:
ci: check test-unit desktop-test desktop-build desktop-tauri-check desktop-tauri-test web-build mobile-test(where
check= fmt-check + clippy + desktop/Tauri/web/mobile lintchecks). Four prose descriptions each claimed a different, incomplete
subset:
(omits desktop, Tauri, and web entirely)
desktop/web builds" (omits mobile and desktop/Tauri tests)
builds" (omits web and mobile)
Since "PRs that fail
just ciwill not be merged", contributors deservean accurate description of what the gate covers.
Fix
Restoring the section was considered and rejected: the current
crates/buzz-dev-mcpcrate is a local dev-tools shim (rg / read_file /shell / str_replace), unrelated to the removed sprout-mcp agent API
surface that section documented, and it has no README to source a
replacement from. Removal matches the intent of chore: deprecate sprout-mcp — fill CLI gaps, remove crate and all references #850.
just cidescriptions to match the recipe: check(fmt + lints across Rust, desktop, Tauri, web, and mobile), unit tests
(Rust, desktop, Tauri, mobile), and the desktop and web builds.
Test evidence
Docs-only change — no code paths touched, no build required per
CONTRIBUTING's own guidance.
Tool" remains anywhere in the repo's markdown after the change
(
grep -rn 'how-to-add-a-new-mcp-tool\|How to Add a New MCP Tool' --include='*.md' .→ no matches).just cienumeration against the Justfilerecipe at line 258 and its sub-recipes (
checkline 94,test-unit,desktop-test,desktop-build,desktop-tauri-check,desktop-tauri-test,web-build,mobile-test).anchors exist.
Links
"How to Add a New MCP Tool" section but missed the ToC entry.
"GitHub Discussion" pointer to Issues (the repo has Discussions
disabled). This PR deliberately does not touch that line to avoid
duplicating docs: prepare project documentation for public release #2228.