Skip to content

Reconcile CONTRIBUTING.md with actual package layout and direct dependency surface#7278

Open
Copilot wants to merge 2 commits into
mainfrom
copilot/update-documentation-reconciliation-report
Open

Reconcile CONTRIBUTING.md with actual package layout and direct dependency surface#7278
Copilot wants to merge 2 commits into
mainfrom
copilot/update-documentation-reconciliation-report

Conversation

Copilot AI commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Nightly documentation reconciliation found two CONTRIBUTING.md drifts: it referenced a non-existent internal/jsonutil/ package and listed github.com/spf13/pflag as a direct dependency even though it is indirect via Cobra. This PR updates CONTRIBUTING.md to match the current implementation and contributor-facing dependency model.

  • Project structure corrections

    • Removed internal/jsonutil/ from the internal/ tree diagram.
    • Removed internal/jsonutil/ from the Key Directories section.
  • strutil ownership clarified

    • Updated internal/strutil/ descriptions (tree + Key Directories) to explicitly include JSON deep-clone utilities, aligning docs with strutil.DeepCloneJSON.
  • Dependency list cleanup

    • Removed github.com/spf13/pflag from CONTRIBUTING.md direct dependencies.
    • Kept Cobra as the direct CLI framework dependency for flag registration guidance.
-    ├── jsonutil/              # JSON deep-clone utilities
-    ├── strutil/               # String and formatting utility helpers
+    ├── strutil/               # String, formatting, and JSON deep-clone utility helpers

- - **`internal/jsonutil/`** - JSON deep-clone utilities
- - **`internal/strutil/`** - String and formatting utility helpers (...)
+ - **`internal/strutil/`** - String, formatting, and JSON deep-clone utility helpers (...)

- - `github.com/spf13/pflag` - POSIX/GNU-style flag parsing used by tracing and CLI integrations

GitHub Advanced Security started work on behalf of lpcox June 9, 2026 15:36 View session
Copilot AI linked an issue Jun 9, 2026 that may be closed by this pull request
GitHub Advanced Security finished work on behalf of lpcox June 9, 2026 15:37
Copilot AI changed the title [WIP] Update documentation for internal/jsonutil directory Reconcile CONTRIBUTING.md with actual package layout and direct dependency surface Jun 9, 2026
Copilot AI requested a review from lpcox June 9, 2026 15:42
Copilot finished work on behalf of lpcox June 9, 2026 15:42
GitHub Advanced Security started work on behalf of lpcox June 9, 2026 15:47 View session
GitHub Advanced Security finished work on behalf of lpcox June 9, 2026 15:49
@lpcox lpcox marked this pull request as ready for review June 10, 2026 13:44
Copilot AI review requested due to automatic review settings June 10, 2026 13:44

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

Updates contributor documentation to reflect the repository’s current internal package layout and the actual direct dependency surface, eliminating drift discovered by nightly reconciliation.

Changes:

  • Removed the nonexistent internal/jsonutil/ package from the project structure diagram and “Key Directories” list.
  • Clarified internal/strutil/ as the home for JSON deep-clone utilities (aligning with strutil.DeepCloneJSON).
  • Removed github.com/spf13/pflag from the “Dependencies” section since it is an indirect dependency (via Cobra).
Show a summary per file
File Description
CONTRIBUTING.md Reconciles internal package structure and dependency documentation with the current codebase and go.mod direct/indirect dependency model.

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

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

3 participants