Reconcile CONTRIBUTING.md with actual package layout and direct dependency surface#7278
Open
Copilot wants to merge 2 commits into
Open
Reconcile CONTRIBUTING.md with actual package layout and direct dependency surface#7278Copilot wants to merge 2 commits into
Copilot wants to merge 2 commits into
Conversation
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
Contributor
There was a problem hiding this comment.
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 withstrutil.DeepCloneJSON). - Removed
github.com/spf13/pflagfrom 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Nightly documentation reconciliation found two CONTRIBUTING.md drifts: it referenced a non-existent
internal/jsonutil/package and listedgithub.com/spf13/pflagas 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
internal/jsonutil/from theinternal/tree diagram.internal/jsonutil/from the Key Directories section.strutilownership clarifiedinternal/strutil/descriptions (tree + Key Directories) to explicitly include JSON deep-clone utilities, aligning docs withstrutil.DeepCloneJSON.Dependency list cleanup
github.com/spf13/pflagfrom CONTRIBUTING.md direct dependencies.