Skip to content

docs: add .lycheecache to source-release exclusions, fix tools/*/.gitignore glob#894

Merged
potiuk merged 1 commit into
apache:mainfrom
shashwat4543:main
Jul 15, 2026
Merged

docs: add .lycheecache to source-release exclusions, fix tools/*/.gitignore glob#894
potiuk merged 1 commit into
apache:mainfrom
shashwat4543:main

Conversation

@shashwat4543

Copy link
Copy Markdown
Contributor

Clarified the description of nested .gitignore files and added details about their structure.

Summary

Add .lycheecache to the excluded-files list in docs/source-release-contents.md.
Also clarify the imprecise tools/*/.gitignore glob description.

Closes #874

Why

.lycheecache is already marked export-ignore in .gitattributes (it sits
right next to .lychee.toml), but it was never listed in the doc's "Files
deliberately excluded" section — the doc undercounts what .gitattributes
actually excludes.

Type of change

  • Skill change (.claude/skills/<name>/) — eval fixtures updated below
  • Tool / bridge contract (tools/<system>/*.md)
  • Python package (tools/*/ with pyproject.toml)
  • Groovy reference impl
  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • [tick ] Documentation (docs/, README.md, CONTRIBUTING.md)
  • Project template (projects/_template/)
  • CI / dev loop (prek, workflows, validators)
  • Other:

Test plan

Doc-only change, no code or behavior affected. Verified both edits against
the current .gitattributes and the real tools/ tree

  • prek run --all-files passes
  • For Python packages touched: uv run pytest / ruff check / mypy passes
  • For Groovy bridges touched: command-line invocation tested end-to-end
  • For skill changes: eval suite passes for the affected skill
    (PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)
  • For skill behaviour changes: a new or updated eval fixture is included in this PR
    (a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
  • Other:

RFC-AI-0004 compliance

  • HITL — any new mutation is gated on explicit user confirmation
  • Sandbox — no new unrestricted host access; network reach declared in the adapter
  • Vendor neutrality — placeholders (<PROJECT>, <tracker>, <upstream>, <security-list>) used in all skill / tool prose (the check-placeholders prek hook is the mechanical gate)
  • Conversational + correctable — agentic-override path documented if behaviour is adopter-tunable
  • Write-access discipline — no autonomous outbound messages; drafts only, sent on confirmation
  • Privacy LLM — private content does not reach a non-approved LLM; redactor invoked where needed

Linked issues

Notes for reviewers (optional)

Clarified the description of nested .gitignore files and added details about their structure.
@potiuk potiuk merged commit 3010469 into apache:main Jul 15, 2026
9 checks passed
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.

docs/source-release-contents.md: missing .lycheecache in excluded-files list

2 participants