Skip to content

Reconcile CONTRIBUTING.md with actual strutil deep-clone location#7326

Merged
lpcox merged 2 commits into
mainfrom
copilot/fix-documentation-reconciliation
Jun 10, 2026
Merged

Reconcile CONTRIBUTING.md with actual strutil deep-clone location#7326
lpcox merged 2 commits into
mainfrom
copilot/fix-documentation-reconciliation

Conversation

Copilot AI commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Nightly docs reconciliation flagged a mismatch between contributor docs and implementation: internal/jsonutil/ was documented despite not existing, while JSON deep-clone utilities are implemented under internal/strutil/. This PR aligns CONTRIBUTING.md with the current code layout.

  • Project structure correction

    • Updated the internal/strutil/ entry in the tree to explicitly include JSON deep-clone utilities.
  • Key directories correction

    • Updated the internal/strutil/ description in the “Key Directories” section to include JSON deep-clone.
    • Removed stale jsonutil wording by using a single accurate description in both sections.
- ├── strutil/               # String, formatting, and JSON deep-clone utility helpers
+ ├── strutil/               # String and formatting utility helpers (deduplication, trimming, duration formatting, JSON deep-clone)

- - **`internal/strutil/`** - String, formatting, and JSON deep-clone utility helpers (deduplication, trimming, duration formatting, deep-clone)
+ - **`internal/strutil/`** - String and formatting utility helpers (deduplication, trimming, duration formatting, JSON deep-clone)

Copilot AI linked an issue Jun 10, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Fix incorrect package reference in CONTRIBUTING.md Reconcile CONTRIBUTING.md with actual strutil deep-clone location Jun 10, 2026
Copilot finished work on behalf of lpcox June 10, 2026 18:07
Copilot AI requested a review from lpcox June 10, 2026 18:07
@lpcox lpcox marked this pull request as ready for review June 10, 2026 19:50
Copilot AI review requested due to automatic review settings June 10, 2026 19:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Aligns contributor documentation with the current repository layout by correctly documenting that JSON deep-clone helpers live under internal/strutil/ (and removing stale wording that implied a separate jsonutil area).

Changes:

  • Updated the “Project Structure” tree entry for internal/strutil/ to explicitly include JSON deep-clone utilities.
  • Updated the “Key Directories” description for internal/strutil/ to match the corrected tree wording.
Show a summary per file
File Description
CONTRIBUTING.md Updates project structure and key-directory descriptions to accurately reflect JSON deep-clone utilities under internal/strutil/.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

@lpcox lpcox merged commit 1824695 into main Jun 10, 2026
39 checks passed
@lpcox lpcox deleted the copilot/fix-documentation-reconciliation branch June 10, 2026 19:54
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.

📚 Documentation Reconciliation Report - 2026-06-09

3 participants