docs(core): correct DEFAULT_IGNORE_PATTERNS comment about bin/#321
Open
KennyUMN wants to merge 1 commit into
Open
docs(core): correct DEFAULT_IGNORE_PATTERNS comment about bin/#321KennyUMN wants to merge 1 commit into
KennyUMN wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates documentation around the default ignore patterns to clarify .NET build output handling and explicitly document why bin/ is not excluded.
Changes:
- Refines the description of .NET-related ignores to focus on
obj/build output. - Adds an explicit note explaining why
bin/is intentionally not excluded, referencing existing test coverage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The block comment claimed the defaults add 'bin/obj for .NET projects', but only obj/ is included. bin/ is intentionally excluded because it holds CLI entrypoint source in Node/Ruby projects (asserted by the 'does not contain bin' test). The inaccurate comment is what led to the confusion in Lum1104#76 about bin/ being missing. Document the intentional exclusion instead.
4614a41 to
0221ce1
Compare
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.
What
The block comment above
DEFAULT_IGNORE_PATTERNSinpackages/core/src/ignore-filter.tssays the defaults add "bin/obj for .NET projects", but onlyobj/is actually included.Why
bin/is intentionally excluded — in Node and Ruby projectsbin/is the conventional location for CLI entrypoint source, which should still be analyzed. This is already enforced by the"does not contain bin (used by Node/Ruby CLI launchers)"test inignore-filter.test.ts. Onlyobj/is pure .NET intermediate build output that's safe to blanket-ignore.The inaccurate comment is what led to the confusion in #76, where it looked like
bin/had simply been forgotten. This documents the exclusion as intentional and points at the test so the next reader doesn't try to "fix" it by addingbin/(which would break the test and start analyzing source as build output).Change
Comment-only. No behavior change.
Testing
pnpm testinpackages/core— all 670 tests pass (33 files), including the fullignore-filtersuite.Refs #76