Skip to content

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

Merged
Hmbown merged 3 commits into
mainfrom
codex/pr-3680-contributing-paths
Jun 27, 2026
Merged

docs(contributing): fix stale file paths in PR exemplars#3684
Hmbown merged 3 commits into
mainfrom
codex/pr-3680-contributing-paths

Conversation

@Hmbown

@Hmbown Hmbown commented Jun 27, 2026

Copy link
Copy Markdown
Owner

Summary

Harvests #3680 by @findshan into a maintainer branch so the docs-only cleanup can land with contributor credit preserved.

  • fixes the stale /init exemplar path
  • fixes the missing crate prefix on the LSP hook path
  • fixes the stale /share exemplar path

Supersedes #3680 after this lands.

Credit

Original PR: #3680 by @findshan. The harvested commit is authored as Wenshan Deng using the canonical GitHub noreply identity 224246733+findshan@users.noreply.github.com and includes Harvested from PR #3680 by @findshan.

Local Verification

  • test -f crates/tui/src/commands/groups/project/init.rs
  • test -f crates/tui/src/core/engine/lsp_hooks.rs
  • test -f crates/tui/src/commands/groups/project/share.rs
  • git diff --check origin/main..HEAD
  • python3 scripts/check-coauthor-trailers.py --author-map .github/AUTHOR_MAP --range origin/main..HEAD --check-authors

Harvested from PR #3680 by @findshan.

The Shape of a Typical PR section pointed to paths that have since moved or were missing the crate prefix:

- #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

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>
@claude

claude Bot commented Jun 27, 2026

Copy link
Copy Markdown

Claude finished @Hmbown's task in 45s —— View job


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

  • Gather context and read changed files
  • Verify file paths actually exist in the codebase
  • Review the diff for correctness
  • Post final review

Summary

Docs-only change, three path corrections in the "Shape of a Typical PR" exemplar block in CONTRIBUTING.md. All three updated paths have been confirmed to exist in the current tree:

PR Old path New path Verified
#386 /init crates/tui/src/commands/init.rs crates/tui/src/commands/groups/project/init.rs ✅ exists
#389 LSP core/engine/lsp_hooks.rs crates/tui/src/core/engine/lsp_hooks.rs ✅ exists
#393 /share crates/tui/src/commands/share.rs crates/tui/src/commands/groups/project/share.rs ✅ exists

The two paths left unchanged (crates/tui/src/lsp/ and crates/cli/src/update.rs) are also correct and present.

Commit / Credit Hygiene

  • Author is Wenshan Deng <224246733+findshan@users.noreply.github.com> — the canonical GitHub noreply identity per .github/AUTHOR_MAP. ✅
  • Harvest attribution trailer Harvested from PR #3680 by @findshan is present. ✅
  • No bot Co-authored-by trailers that would trip check-coauthor-trailers.py. ✅
  • Signed-off-by: findshan <dengwenshan123456@outlook.com> is a DCO trailer, not a co-author trailer — no CI conflict. ✅

Verdict

No issues found. The diff is minimal, factually correct, and contributor credit is properly preserved. Ready to merge.

@Hmbown

Hmbown commented Jun 27, 2026

Copy link
Copy Markdown
Owner Author

Checks are green and this is ready from my side, but GitHub branch policy is blocking a normal merge and repository auto-merge is disabled. I am leaving it open rather than using an admin bypass. This still preserves @findshan credit and supersedes #3680 once it can land.

@claude

claude Bot commented Jun 27, 2026

Copy link
Copy Markdown

Claude finished @Hmbown's task in 41s —— View job


  • Gather context
  • Review diff and verify paths
  • Post final review

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

Docs-only change — three path corrections in the "Shape of a Typical PR" exemplar block in CONTRIBUTING.md. The synchronize event added a merge-from-main commit; no new functional changes beyond the original harvest.

Path Verification

Exemplar Old path New path Status
#386 /init crates/tui/src/commands/init.rs crates/tui/src/commands/groups/project/init.rs ✅ exists
#389 LSP core/engine/lsp_hooks.rs crates/tui/src/core/engine/lsp_hooks.rs ✅ exists
#393 /share crates/tui/src/commands/share.rs crates/tui/src/commands/groups/project/share.rs ✅ exists

Unchanged paths (crates/tui/src/lsp/, crates/cli/src/update.rs) remain correct.

Commit / Credit Hygiene

  • Harvest commit authored as Wenshan Deng <224246733+findshan@users.noreply.github.com> — canonical identity per .github/AUTHOR_MAP. ✅
  • Harvested from PR #3680 by @findshan attribution trailer present. ✅
  • No bot Co-authored-by trailers. ✅
  • Signed-off-by DCO trailer is not a co-author trailer — no CI conflict. ✅
  • Merge commit (55e8e6b) is a clean Merge branch 'main' into ... — no unrelated changes introduced. ✅

Verdict

No issues. The diff is minimal, factually correct, and contributor credit is properly preserved. Ready to merge.

@Hmbown

Hmbown commented Jun 27, 2026

Copy link
Copy Markdown
Owner Author

Re-tried this today during the 0.8.66 PR sweep. The diff is still clean, the check set and credit hygiene are still good, and this remains the preferred landing path for #3680 because it preserves @findshan's contribution cleanly.

GitHub still blocks a normal merge with branch policy, and --auto is unavailable because repository auto-merge is disabled (enablePullRequestAutoMerge). I am continuing to avoid an admin bypass here. This remains ready once a maintainer/admin merge path is available.

@claude

claude Bot commented Jun 27, 2026

Copy link
Copy Markdown

Claude finished @Hmbown's task in 46s —— View job


  • Gather context
  • Review current diff and verify paths
  • Post final review

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

Docs-only change — three path corrections in the "Shape of a Typical PR" exemplar block in CONTRIBUTING.md. The synchronize event added a second merge-from-main commit (a9fb386); no new functional changes beyond the original harvest.

Path Verification

Exemplar Old path New path Status
#386 /init crates/tui/src/commands/init.rs crates/tui/src/commands/groups/project/init.rs ✅ exists
#389 LSP core/engine/lsp_hooks.rs crates/tui/src/core/engine/lsp_hooks.rs ✅ exists
#393 /share crates/tui/src/commands/share.rs crates/tui/src/commands/groups/project/share.rs ✅ exists

Unchanged paths (crates/tui/src/lsp/, crates/cli/src/update.rs) remain correct.

Commit / Credit Hygiene

  • Harvest commit (0d0c2c2) authored as Wenshan Deng <224246733+findshan@users.noreply.github.com> — canonical identity per .github/AUTHOR_MAP. ✅
  • Harvested from PR #3680 by @findshan attribution trailer present. ✅
  • No bot Co-authored-by trailers. ✅
  • Signed-off-by DCO trailer is not a co-author trailer — no CI conflict. ✅
  • Both merge commits (55e8e6b, a9fb386) are clean Merge branch 'main' into ... — no unrelated changes introduced. ✅

Verdict

No issues. The diff is minimal, factually correct, and contributor credit is properly preserved. Ready to merge.

@Hmbown Hmbown merged commit 0bf76a1 into main Jun 27, 2026
18 checks passed
@Hmbown Hmbown deleted the codex/pr-3680-contributing-paths branch June 27, 2026 18:17
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.

2 participants