Skip to content

docs: state that .gitignore is not consulted, with the ignore key as the exclusion list - #326

Open
MaximeGaudin wants to merge 2 commits into
mainfrom
fix/issue-37-gitignore-doc
Open

MaximeGaudin wants to merge 2 commits into
mainfrom
fix/issue-37-gitignore-doc

Conversation

@MaximeGaudin

Copy link
Copy Markdown
Owner

Summary

  • .gitignore was never consulted, so a git-ignored build/output directory was linted by default, and nothing said why.
  • This issue offered two resolutions: walk with the ignore crate (a new dependency tree the repo does not currently carry), or document the tradeoff. This PR takes the documented-tradeoff option the issue names: the README and the config docs now state that .gitignore is not read and that the ignore key is the exclusion list, with a **/build-output/** example.
  • A regression test pins the behaviour — a git-ignored directory is linted — so a future change that starts honouring .gitignore (for example by adopting the ignore crate) cannot land silently; the test and the docs must be updated together.

Fixes #37

Test plan

  • New test pins the documented behaviour (passes before and after; it is a contract pin, not a red test, because this resolution is documentation)
  • Local checks mirror CI and passed before push (./scripts/check.sh, JS included)
  • CI green on the PR

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.

config/discovery: .gitignore is never consulted, so build output and other git-ignored directories are linted by default

1 participant