docs: explain import roots in the README quickstart - #66
Open
LukasNiessen wants to merge 1 commit into
Open
LukasNiessen wants to merge 1 commit into
LukasNiessen wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
The README used project_files("src/") and metrics("src/") without explaining how that argument affects import resolution. In a src layout, filtering with in_path("src/**") alone can leave first-party imports classified as external and hide architecture violations.
Add a short import-root explanation before the first test example, linked to a detailed Setup section. Document the working-directory default, source-root versus selector behavior, examples for src, flat, and backend layouts, and the effect on dependency rules and metrics. Simplify the first cycle example by removing its redundant folder filter.
Validation:
README-only change; no runtime behavior changes.