Skip to content

docs: reposition messaging to lead with AI metadata (GIT-106)#73

Merged
TonyCasey merged 3 commits intomainfrom
git-106
Feb 15, 2026
Merged

docs: reposition messaging to lead with AI metadata (GIT-106)#73
TonyCasey merged 3 commits intomainfrom
git-106

Conversation

@TonyCasey
Copy link
Copy Markdown
Owner

@TonyCasey TonyCasey commented Feb 15, 2026

Summary

  • Repositioned README to lead with AI metadata tracking ("Track AI contributions in your git history")
  • Restructured getting-started.md: git hooks and trailers first, Claude Code hooks as "extra feature"
  • Updated all config references from .git-mem.json to .git-mem/.git-mem.yaml
  • Consolidated CHANGELOG: all post-0.3.0 features now in 0.4.0
  • Bumped version to 0.4.0

Test plan

  • Review README messaging for clarity
  • Review getting-started.md flow
  • Verify YAML config examples are correct

Closes GIT-106

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Intent extraction and query-based memory recall
    • Optional LLM enrichment in commit hooks (configurable timeout)
    • Claude Code integration for AI metadata tracking
  • Changed

    • Configuration format migrated from root JSON to nested YAML under tool config
    • Commit messages now include AI metadata fields and full commit bodies exposed to memory
    • Streamlined setup and DI-centric behavior
  • Documentation

    • README and getting-started rewritten with concise examples and new workflow guidance

- README: lead with "Track AI contributions in your git history"
- getting-started: show AI trailers first, Claude Code hooks as extra feature
- Update config references from .git-mem.json to .git-mem/.git-mem.yaml
- CHANGELOG: consolidate post-0.3.0 work into 0.4.0 release
- Bump version to 0.4.0

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
AI-Agent: Claude-Code/2.1.42
AI-Model: claude-opus-4-5-20251101
AI-Decision: The project has repositioned its messaging to lead with AI metadata tracking rather than memory extraction, suggesting the primary value prop is tracking AI contributions in git history.
AI-Confidence: verified
AI-Tags: documentation, product-positioning, ai-metadata, configuration, yaml, migration, breaking-change, versioning, changelog, feature-consolidation, hooks, error-handling, config, reliability, git-trailers, commit-format, timeout, claude-code
AI-Lifecycle: project
AI-Memory-Id: 56f52b0b
AI-Source: llm-enrichment
Copilot AI review requested due to automatic review settings February 15, 2026 18:41
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 15, 2026

📝 Walkthrough

Walkthrough

Updates release notes, docs, and README for version 0.4.0; migrates config from top-level JSON to .git-mem/.git-mem.yaml; introduces AI metadata terminology and documents new intent-extraction APIs and MemoryContextLoader.loadWithQuery.

Changes

Cohort / File(s) Summary
Documentation
README.md, docs/getting-started.md, CLAUDE.md
Rewrites onboarding and getting-started flow, adds AI metadata examples (AI-Agent, AI-Model, AI-Decision, AI-Context), introduces Claude Code integration guidance, and updates config references to .git-mem/.git-mem.yaml.
Release & Package
CHANGELOG.md, package.json
Bumps package to 0.4.0 and documents 0.4.0 changes: intent-extraction feature, YAML config migration, MemoryContextLoader.loadWithQuery, and hook/LLM enrichment notes.
Public API / Services
src/.../IIntentExtractor*, src/.../IntentExtractor*, src/.../MemoryContextLoader*
Adds exported interface IIntentExtractor, service IntentExtractor, and new method signature MemoryContextLoader.loadWithQuery on the memory loader surface (public API additions).

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer (commit)
    participant Hook as Git Hook
    participant Intent as IntentExtractor
    participant Loader as MemoryContextLoader
    participant LLM as LLM/Enrichment
    participant Repo as Repository (commit-msg)

    Dev->>Hook: create/prepare commit
    Hook->>Intent: extract intent (IIntentExtractor)
    Intent->>Loader: loadWithQuery (targeted recall)
    Loader->>LLM: provide context (optional enrichment)
    LLM-->>Hook: enriched metadata / intent
    Hook->>Repo: attach AI metadata trailers to commit
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Merge Conflict Detection ⚠️ Warning ❌ Merge conflicts detected (10 files):

⚔️ CHANGELOG.md (content)
⚔️ CLAUDE.md (content)
⚔️ README.md (content)
⚔️ docs/getting-started.md (content)
⚔️ package.json (content)
⚔️ src/application/services/MemoryService.ts (content)
⚔️ src/commands/init-hooks.ts (content)
⚔️ src/infrastructure/repositories/MemoryRepository.ts (content)
⚔️ tests/unit/application/services/MemoryService.test.ts (content)
⚔️ tests/unit/infrastructure/repositories/MemoryRepository.test.ts (content)

These conflicts must be resolved before merging into main.
Resolve conflicts locally and push changes to this branch.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: repositioning documentation messaging to prioritize AI metadata tracking, which aligns with the comprehensive restructuring across README, getting-started.md, and CHANGELOG.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch git-106
⚔️ Resolve merge conflicts (beta)
  • Auto-commit resolved conflicts to branch git-106
  • Create stacked PR with resolved conflicts
  • Post resolved changes as copyable diffs in a comment

No actionable comments were generated in the recent review. 🎉


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Line 26: Update the phrase "Backwards compatible migration from JSON" to
hyphenate the compound adjective: replace it with "Backwards-compatible
migration from JSON" so the compound modifier correctly modifies "migration".

In `@docs/getting-started.md`:
- Around line 15-22: The fenced code block containing the commit metadata
(starting with "feat: add user authentication" and the AI-Agent/AI-Model lines)
is missing a language tag; update the opening triple-backtick to include a
language identifier (e.g., "text" or "git") so Markdown linting and highlighting
work correctly — locate the code block that wraps the lines "feat: add user
authentication" / "AI-Agent: claude-code" and change the fence from ``` to
```text (or ```git).

In `@README.md`:
- Around line 15-23: The fenced code block in README.md containing the lines
starting with "feat: add user authentication" and the
AI-Agent/AI-Model/AI-Decision/AI-Context metadata should include a language
identifier (e.g., change the opening ``` to ```text or ```git) so Markdown
linters and highlighters recognize it; update that opening fence for the block
that contains "AI-Agent: claude-code" to use a language specifier.

- Hyphenate "Backwards-compatible" in CHANGELOG
- Add language identifiers to code blocks in README and getting-started

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
AI-Agent: Claude-Code/2.1.42
AI-Model: claude-opus-4-5-20251101
AI-Convention: Documentation code blocks should include language identifiers for proper syntax highlighting and formatting.
AI-Confidence: verified
AI-Tags: documentation, markdown, code-blocks, syntax-highlighting, grammar, changelog, technical-writing, code-review, tooling, development-process
AI-Lifecycle: project
AI-Memory-Id: 5034f6a6
AI-Source: llm-enrichment
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the project’s documentation and release metadata to emphasize AI trailer/metadata tracking as the primary value proposition, aligning docs and changelog with the YAML-based config layout and the 0.4.0 release.

Changes:

  • Repositions README + getting-started flow to lead with AI commit trailers/metadata, with “memory” as an additional capability.
  • Updates config references to .git-mem/.git-mem.yaml and refreshes Claude Code integration docs.
  • Consolidates CHANGELOG entries and bumps package version to 0.4.0.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
package.json Bumps npm package version to 0.4.0.
docs/getting-started.md Reorders onboarding docs and updates examples/config references.
README.md Rewrites top-level messaging to focus on AI metadata in git history.
CLAUDE.md Updates internal contributor notes for YAML config and adds workflow references.
CHANGELOG.md Consolidates post-0.3.0 notes into a 0.4.0 section and adds doc-related entries.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

{
"name": "git-mem",
"version": "0.3.0",
"version": "0.4.0",
Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

package.json version was bumped to 0.4.0, but package-lock.json still reports 0.3.0. If this repo commits package-lock.json, update it (or regenerate lockfile) so the package metadata stays consistent for installs/publishing.

Suggested change
"version": "0.4.0",
"version": "0.3.0",

Copilot uses AI. Check for mistakes.
AI-Agent: claude-code
AI-Model: claude-sonnet-4-5-20250929
AI-Decision: JWT over sessions — stateless API, scales horizontally
AI-Context: [pattern/middleware, entity/auth-module]
Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

The example commit trailers include AI-Context, but the implementation only defines trailers like AI-Tags, AI-Lifecycle, AI-Memory-Id, etc. Consider replacing AI-Context with a supported trailer (likely AI-Tags) so users don’t look for a non-existent trailer key.

Suggested change
AI-Context: [pattern/middleware, entity/auth-module]
AI-Tags: pattern/middleware, entity/auth-module

Copilot uses AI. Check for mistakes.
Comment on lines 105 to +113
- Branch per Linear issue, named with ticket number (e.g. `GIT-15`)
- Use the SKILL .claude/skills/github/SKILL.md for interacting with GitHub
- PR workflow use the skill .claude/skills/pr/SKILL.md
- Create the PR
- Wait for 120 seconds to allow for review from coderabbit
- Address comments directly inline to the comment
- if a fix is applied, mark the comment as resolved
- wait for another 120 seconds to allow for review from coderabbit
- repeat the steps until all comments are resolved
Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

The new guidance references .claude/skills/github/SKILL.md and .claude/skills/pr/SKILL.md, but there is no .claude/skills/ directory in this repo. Either commit those skill docs or update/remove these bullets so the workflow instructions are actionable.

Copilot uses AI. Check for mistakes.
Comment on lines +10 to +13
### Changed

- **Documentation repositioning** — README and getting-started now lead with AI metadata tracking, memory as "level up"

Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

This PR appears to ship 0.4.0 (version bump + 0.4.0 section), but “Documentation repositioning” is still listed under [Unreleased]. Move it into the 0.4.0 section (likely under “Changed”) or remove it from Unreleased to avoid double-counting.

Copilot uses AI. Check for mistakes.
- `loadWithQuery` method on `MemoryContextLoader` for targeted recall
- Configurable via `promptSubmit.extractIntent` in config
- **Commit message bodies** — memory context now includes full commit message bodies, not just subjects
- **YAML configuration** — `.git-mem.yaml` replaces `.git-mem.json`:
Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

Changelog says “.git-mem.yaml replaces .git-mem.json”, but the actual config path is .git-mem/.git-mem.yaml (file inside the .git-mem/ directory). Consider updating the changelog wording to the full path to avoid confusion.

Suggested change
- **YAML configuration**`.git-mem.yaml` replaces `.git-mem.json`:
- **YAML configuration**`.git-mem/.git-mem.yaml` replaces `.git-mem.json`:

Copilot uses AI. Check for mistakes.
## What `init` sets up

git-mem stores knowledge in two ways:
1. **Git hooks** — `prepare-commit-msg` and `commit-msg` add AI trailers to every commit
Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

Docs say init sets up only prepare-commit-msg and commit-msg, but init also installs a post-commit hook. Update this list to include post-commit (and briefly what it does) to match actual behavior.

Suggested change
1. **Git hooks**`prepare-commit-msg` and `commit-msg` add AI trailers to every commit
1. **Git hooks**`prepare-commit-msg`, `commit-msg`, and `post-commit` add and record AI trailers for every commit

Copilot uses AI. Check for mistakes.
### extract

Scan commit history, score commits by interest, and extract decisions/gotchas/conventions as memories.
Scans commit history, scores commits by interest, and extract decisions/gotchas/conventions as memories for AI context.
Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

Grammar: “Scans commit history, scores commits by interest, and extract …” should be “extracts …” (subject/verb agreement).

Suggested change
Scans commit history, scores commits by interest, and extract decisions/gotchas/conventions as memories for AI context.
Scans commit history, scores commits by interest, and extracts decisions/gotchas/conventions as memories for AI context.

Copilot uses AI. Check for mistakes.
AI-Agent: claude-code
AI-Model: claude-sonnet-4-5-20250929
AI-Decision: JWT over sessions — stateless API, scales horizontally
AI-Context: [pattern/middleware, entity/auth-module]
Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

The README example includes an AI-Context trailer, but there’s no AI-Context trailer key in the codebase (the closest concept is AI-Tags). Update the example to use a supported trailer name so it matches what the hooks actually write.

Suggested change
AI-Context: [pattern/middleware, entity/auth-module]
AI-Tags: [pattern/middleware, entity/auth-module]

Copilot uses AI. Check for mistakes.
Comment on lines 91 to +95
- `code-quality-rules.md` - TypeScript/ESLint configuration, error prevention
- `git-rules.md` - Commit workflow, PR creation, memory milestones
- `testing-principles.md` - Testing pyramid, mocking strategies
- `memory-rules.md` - Handling session memory

Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

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

These new references to .claude/rules/memory-rules.md (and the .claude/rules/ directory) don’t exist in the repository. Either add the referenced rule file(s) or update CLAUDE.md to point at a path that actually exists so contributors can follow the guidance.

Copilot uses AI. Check for mistakes.
@TonyCasey TonyCasey merged commit 5b34b58 into main Feb 15, 2026
3 checks passed
@TonyCasey TonyCasey deleted the git-106 branch February 15, 2026 18:50
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