Skip to content

docs: add CLAUDE.md project guide#13

Closed
lpillmann wants to merge 1 commit intomainfrom
feat/add-claude-md
Closed

docs: add CLAUDE.md project guide#13
lpillmann wants to merge 1 commit intomainfrom
feat/add-claude-md

Conversation

@lpillmann
Copy link
Copy Markdown
Collaborator

@lpillmann lpillmann commented Feb 21, 2026

Summary

  • Adds CLAUDE.md to the permifrost repo so Claude Code and contributors immediately understand the project context
  • Documents that this repo is a Gemma Analytics fork of the upstream project at https://gitlab.com/gitlab-data/permifrost
  • Notes the relationship with tundri (object DDL) and permifrost (permission grants)

Changes

  • New file: CLAUDE.md

What's in the CLAUDE.md

Section Content
What is Permifrost Fork origin, purpose, relationship to tundri
Development Commands Install, run, test, lint
Architecture Module overview table, execution flow
Environment Variables Required Snowflake env vars
Key Files pyproject.toml, VERSION, GEMMA_RELEASE.md
Release Process bumpversion + twine workflow
Conventions Source layout, never commit to main

Testing

No code changes — documentation only.

Linear Issue

Closes https://linear.app/gemma-analytics/issue/GEM-6/permifrost-repo-lacks-claudemd

🤖 Generated with Claude Code

Adds a CLAUDE.md that documents what the repo is, its fork origin
(https://gitlab.com/gitlab-data/permifrost), development commands,
architecture overview, and conventions for contributors.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@lpillmann
Copy link
Copy Markdown
Collaborator Author

@claude solve the conflicts for me and push a new reconciled version that is the most complete combination of the contributions

@lpillmann
Copy link
Copy Markdown
Collaborator Author

Closing as superseded — the CLAUDE.md content from this PR was already incorporated into main via PRs #14 and #15. The follow-up workflow guidance (superpowers plugin, TDD steps, plan files) is covered by PR #17.

@lpillmann lpillmann closed this Apr 21, 2026
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.

1 participant