Skip to content

docs: add CLAUDE.md and note Lightricks fork in README#26

Merged
Nana Mensa-Bonsu (kombonsu) merged 1 commit into
mainfrom
docs/add-claude-md
May 5, 2026
Merged

docs: add CLAUDE.md and note Lightricks fork in README#26
Nana Mensa-Bonsu (kombonsu) merged 1 commit into
mainfrom
docs/add-claude-md

Conversation

@kombonsu

Copy link
Copy Markdown
Contributor

Summary

  • Adds a repo-level CLAUDE.md describing the layout, common commands, GCP/GKE context, and conventions for this Lightricks fork of actions/runner.
  • Documents the actual relationship between images/Dockerfile's RUNNER_VERSION ARG (controls the bundled runner binary) and src/runnerversion (only stamps the image tag/label) — these can drift today (0.0.1 vs 2.329.0); the doc flags that.
  • Adds a short fork-context blurb at the top of the upstream README.md so visitors immediately understand which parts are Lightricks-owned.
  • Establishes a working-agreement that untracked files in the working tree belong to the contributor and must not be auto-staged by Claude Code.

Test plan

  • CLAUDE.md and README render correctly in GitHub
  • No unintended files staged (pre-existing untracked files excluded)
  • **.md path filter on build.yml means this PR skips the .NET CI matrix as intended

Adds repository-level guidance for Claude Code: layout map, common
commands, GCP/GKE context, and conventions specific to this fork
(notably that images/Dockerfile's RUNNER_VERSION ARG — not
src/runnerversion — controls the bundled runner binary).

Adds a fork-context blurb to the upstream README so contributors
landing on the repo immediately know which parts are Lightricks-owned
vs. mirrored from actions/runner.

Includes a working-agreement: untracked files in the working tree
belong to the contributor and must not be auto-staged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

@erez-levi Erez Levy (erez-levi) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm 👍

@kombonsu Nana Mensa-Bonsu (kombonsu) merged commit 5ecf75e into main May 5, 2026
1 check passed
@kombonsu Nana Mensa-Bonsu (kombonsu) deleted the docs/add-claude-md branch May 5, 2026 06:09
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.

2 participants