docs(contributing): fix stale file paths in PR exemplars#3680
Conversation
The 'Shape of a Typical PR' section pointed to paths that have since moved or were missing the crate prefix: - Hmbown#386 /init: crates/tui/src/commands/init.rs -> crates/tui/src/commands/groups/project/init.rs - Hmbown#389 LSP: core/engine/lsp_hooks.rs -> crates/tui/src/core/engine/lsp_hooks.rs - Hmbown#393 /share: crates/tui/src/commands/share.rs -> crates/tui/src/commands/groups/project/share.rs Verified each path against the current tree (the grouped commands now live under commands/groups/project/). The crates/tui/src/lsp/ and crates/cli/src/update.rs references in the same block are already correct and were left unchanged. Signed-off-by: findshan <dengwenshan123456@outlook.com>
|
Thanks @findshan for taking the time to contribute. This repository is observing a maintainer-managed PR intake gate in dry-run mode, so this pull request is staying open. This note helps maintainers prepare the allowlist before any enforcement is considered. Please read |
|
/lgtm Thank you @findshan — this is exactly the kind of small contributor-experience cleanup that helps new PR authors. I verified the three updated paths against the current tree, and the diff is nicely scoped. |
|
Update: #3684 is green, but a normal merge is blocked by repository branch policy and auto-merge is disabled. I am leaving both open instead of using an admin bypass. The maintainer-branch harvest remains ready and preserves your credit once the policy gate can be satisfied. |
|
Rechecked during the 0.8.66 PR sweep. #3684 remains the preferred landing path because it preserves your credit and has the full maintainer-branch check set, but GitHub is still blocking that merge through branch policy and disabled auto-merge. Leaving this open until #3684 can land, then this source PR should close as superseded. Thank you again @findshan for catching and fixing the stale contributing-guide paths. |
Harvests #3680 by @findshan with contributor credit preserved. Updates stale PR exemplar paths in CONTRIBUTING.md so contributor guidance points at current CodeWhale paths. Verification: GitHub checks green after refreshing onto the fixed light-PR CI workflow: Change detection, Lint, Test ubuntu/macOS/Windows, npm wrapper smoke, Version drift, CodeQL, DCO, Claude review, gate, and GitGuardian. Thank you @findshan for catching and fixing the stale guide paths.
|
Thanks @findshan — your contribution landed in
Closing this PR now that the code is on If you want to land more work and would prefer your future PRs merge cleanly without a harvest step, the |
Harvested from PR Hmbown#3680 by @findshan. The Shape of a Typical PR section pointed to paths that have since moved or were missing the crate prefix: - Hmbown#386 /init: crates/tui/src/commands/init.rs -> crates/tui/src/commands/groups/project/init.rs - Hmbown#389 LSP: core/engine/lsp_hooks.rs -> crates/tui/src/core/engine/lsp_hooks.rs - Hmbown#393 /share: crates/tui/src/commands/share.rs -> crates/tui/src/commands/groups/project/share.rs Verified each path against the current tree. The crates/tui/src/lsp/ and crates/cli/src/update.rs references in the same block are already correct and were left unchanged. Signed-off-by: findshan <dengwenshan123456@outlook.com>
Summary
Fixes three stale file paths in the "Shape of a Typical PR" exemplars in
CONTRIBUTING.md. The grouped commands have since moved undercommands/groups/project/, and one path was missing its crate prefix. Newcontributors clicking through these examples currently land on non-existent
paths.
/initcrates/tui/src/commands/init.rscrates/tui/src/commands/groups/project/init.rscore/engine/lsp_hooks.rscrates/tui/src/core/engine/lsp_hooks.rs/sharecrates/tui/src/commands/share.rscrates/tui/src/commands/groups/project/share.rsEach new path was verified against the current tree. The
crates/tui/src/lsp/andcrates/cli/src/update.rsreferences in the sameblock are already correct and were intentionally left unchanged.
Testing
Docs-only change (no Rust sources touched), so the build/lint/test gate is
not applicable here:
cargo fmt --all -- --check— n/a (no.rschanges)cargo clippy --workspace --all-targets --all-features— n/acargo test --workspace --all-features— n/aVerification performed instead:
find . -name init.rs -path '*commands*'→crates/tui/src/commands/groups/project/init.rsfind . -name lsp_hooks.rs→crates/tui/src/core/engine/lsp_hooks.rsfind . -name share.rs -path '*commands*'→crates/tui/src/commands/groups/project/share.rsChecklist