Skip to content

docs(contributing): fix stale file paths in PR exemplars#3680

Closed
findshan wants to merge 1 commit into
Hmbown:mainfrom
findshan:docs/fix-stale-pr-example-paths
Closed

docs(contributing): fix stale file paths in PR exemplars#3680
findshan wants to merge 1 commit into
Hmbown:mainfrom
findshan:docs/fix-stale-pr-example-paths

Conversation

@findshan

Copy link
Copy Markdown
Contributor

Summary

Fixes three stale file paths in the "Shape of a Typical PR" exemplars in
CONTRIBUTING.md. The grouped commands have since moved under
commands/groups/project/, and one path was missing its crate prefix. New
contributors clicking through these examples currently land on non-existent
paths.

Exemplar Before After
#386 /init crates/tui/src/commands/init.rs crates/tui/src/commands/groups/project/init.rs
#389 LSP core/engine/lsp_hooks.rs crates/tui/src/core/engine/lsp_hooks.rs
#393 /share crates/tui/src/commands/share.rs crates/tui/src/commands/groups/project/share.rs

Each new path was verified 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 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 .rs changes)
  • cargo clippy --workspace --all-targets --all-features — n/a
  • cargo test --workspace --all-features — n/a

Verification performed instead:

  • find . -name init.rs -path '*commands*'crates/tui/src/commands/groups/project/init.rs
  • find . -name lsp_hooks.rscrates/tui/src/core/engine/lsp_hooks.rs
  • find . -name share.rs -path '*commands*'crates/tui/src/commands/groups/project/share.rs

Checklist

  • Updated docs or comments as needed
  • Added or updated tests where relevant — n/a (docs only)
  • Verified TUI behavior manually if UI changes — n/a (docs only)
  • Harvested/co-authored credit uses a GitHub numeric noreply address — n/a

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>
@findshan findshan requested a review from Hmbown as a code owner June 27, 2026 02:24
@github-actions

Copy link
Copy Markdown

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 CONTRIBUTING.md for the expected contribution shape. A maintainer can grant recurring PR access by commenting /lgtm on a pull request.

@Hmbown

Hmbown commented Jun 27, 2026

Copy link
Copy Markdown
Owner

/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.

@Hmbown

Hmbown commented Jun 27, 2026

Copy link
Copy Markdown
Owner

I opened #3684 as a maintainer-branch harvest so this docs-only cleanup can land with full credit and without getting stuck behind the fork/gate shape. Leaving this PR open until #3684 lands, then I will close it as superseded with the merge commit linked. Thanks again @findshan.

@Hmbown

Hmbown commented Jun 27, 2026

Copy link
Copy Markdown
Owner

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.

@Hmbown

Hmbown commented Jun 27, 2026

Copy link
Copy Markdown
Owner

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.

Hmbown added a commit that referenced this pull request Jun 27, 2026
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.
@github-actions

Copy link
Copy Markdown

Thanks @findshan — your contribution landed in 0d0c2c239275 on main:

docs(contributing): fix stale file paths in PR exemplars

Closing this PR now that the code is on main. Credit lives in the commit message and (where applicable) the CHANGELOG.md entry for the next release. Apologies for not closing this at the time of the merge — the auto-close workflow is new in v0.8.31.

If you want to land more work and would prefer your future PRs merge cleanly without a harvest step, the CONTRIBUTING.md doc has a short note on what makes a contribution mergeable as-is.

@github-actions github-actions Bot closed this Jun 27, 2026
pull Bot pushed a commit to 1sLand99/CodeWhale that referenced this pull request Jun 27, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants