Repository navigation
chore(docs): reconcile the inventory with what git archive actually produces - #11
Merged
Merged
Conversation
…roduces Module root has always held nine files; the summary said seven and the tree listing omitted LICENSE and composer.json entirely, so the total was short by two from the day those files were added. Counted against the real archive: 129, matching every other row. .gitattributes is rewritten with LF endings. Cosmetic -- git parses it either way, and export-ignore has been applying correctly all along.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates the documentation inventory to accurately reflect the contents of the module release archive and normalizes .gitattributes line endings without changing its semantics. Sequence diagram for git archive export-ignore and docs reconciliationsequenceDiagram
actor Developer
participant Git
participant gitattributes
participant Release_archive
participant Docs_file_list_md
Developer->>Git: git archive
Git->>gitattributes: export-ignore rules
Git->>Release_archive: create release tree
Developer->>Release_archive: inspect contents
Developer->>Docs_file_list_md: update file counts and listing
Flow diagram for reconciling docs with the release archiveflowchart TD
A[Repository tree] --> B[git archive]
B --> C[Release archive]
C --> D[Compare with docs/file-list.md]
D --> E[Adjust module root count 7 -> 9]
D --> F[Adjust total count 127 -> 129]
D --> G[Add LICENSE and composer.json to tree listing]
A --> H[.gitattributes]
H --> I[Normalize line endings LF]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe change updates release archive exclusions in ChangesRelease packaging
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/file-list.md" line_range="9" />
<code_context>
| Area | Files | Purpose |
|---|---:|---|
-| Module root | 7 | Manifest, entry points, README, and changelog |
+| Module root | 9 | Manifest, entry points, README, changelog, licence, and the Composer manifest |
| Administration | 8 | Home, Analytics, Logs, Diagnostics, navigation, and wrappers |
| PHP classes | 27 | Collection, profiling, storage, diagnostics, event/template collectors, and optional Ray bridge |
</code_context>
<issue_to_address>
**nitpick (typo):** Consider aligning the spelling of "licence" with the actual `LICENSE` filename for consistency.
Here you list "licence" while the file is actually named `LICENSE`. Please either use "license" or reference `LICENSE` directly so the wording matches the filename and avoids confusion.
```suggestion
| Module root | 9 | Manifest, entry points, README, changelog, `LICENSE`, and the Composer manifest |
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| | Area | Files | Purpose | | ||
| |---|---:|---| | ||
| | Module root | 7 | Manifest, entry points, README, and changelog | | ||
| | Module root | 9 | Manifest, entry points, README, changelog, licence, and the Composer manifest | |
There was a problem hiding this comment.
nitpick (typo): Consider aligning the spelling of "licence" with the actual LICENSE filename for consistency.
Here you list "licence" while the file is actually named LICENSE. Please either use "license" or reference LICENSE directly so the wording matches the filename and avoids confusion.
Suggested change
| | Module root | 9 | Manifest, entry points, README, changelog, licence, and the Composer manifest | | |
| | Module root | 9 | Manifest, entry points, README, changelog, `LICENSE`, and the Composer manifest | |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documented release-tree inventory for modules/debugbar so it matches what git archive actually exports, and normalizes .gitattributes formatting while keeping its export behavior consistent.
Changes:
- Fix the documented module root count and overall total to include
LICENSEandcomposer.json(127 → 129). - Update the documented tree listing to include
LICENSEandcomposer.json. - Normalize
.gitattributesformatting (LF note/blank line cleanup) and adjustexport-ignoreentries.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/file-list.md | Reconciles documented file counts and root listing with the actual archive contents. |
| .gitattributes | Normalizes formatting and updates export-ignore rules used by git archive. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Area | Files | Purpose | | ||
| |---|---:|---| | ||
| | Module root | 7 | Manifest, entry points, README, and changelog | | ||
| | Module root | 9 | Manifest, entry points, README, changelog, licence, and the Composer manifest | |
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.
Module root has always held nine files; the summary said seven and the tree
listing omitted LICENSE and composer.json entirely, so the total was short by
two from the day those files were added. Counted against the real archive:
129, matching every other row.
.gitattributes is rewritten with LF endings. Cosmetic -- git parses it either
way, and export-ignore has been applying correctly all along.
Summary by Sourcery
Update documentation inventory to match the actual module archive contents and normalize .gitattributes formatting.
Documentation:
Chores:
Summary by CodeRabbit
Documentation
Chores