Skip to content

Commit ba65fb4

Browse files
committed
feat: add official fixtures and demo walkthroughs
1 parent 36f7275 commit ba65fb4

22 files changed

Lines changed: 139 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
## 0.18.0 - 2026-03-13
4+
5+
- added official fixtures for generic JSON, Cline/Roo, AGENTS.md, Cursor, and Claude layouts
6+
- added demo guide with reproducible CLI walkthroughs
7+
- documented fixture usage for contributors and demos
8+
39
## 0.17.0 - 2026-03-12
410

511
- added GitHub Actions CI for tests and CLI smoke checks

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,7 @@ Please include:
3232
## Continuous integration
3333

3434
Pull requests are validated by GitHub Actions on Python 3.11 and 3.12. The workflow runs unit tests and a small end-to-end CLI smoke test.
35+
36+
## Fixtures and demos
37+
38+
When adding a new adapter or workflow, prefer adding or updating a sample under `fixtures/` and documenting a reproducible command in `docs/demo.md`.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ The architecture is intentionally adapter-first, so more products can be added w
5959

6060
GitHub Actions runs unit tests plus a CLI smoke test for `bundle` and `verify` on pushes and pull requests.
6161

62+
## Fixtures
63+
64+
Official sample inputs live in `fixtures/`. See `docs/demo.md` for reproducible walkthroughs using the included demo data.
65+
6266
## Installation
6367

6468
```bash

docs/demo.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Demo Guide
2+
3+
This repository includes official sample fixtures under `fixtures/`.
4+
5+
## Quick demo
6+
7+
List adapters:
8+
9+
```bash
10+
memory-migrate adapters
11+
```
12+
13+
Inspect a fixture:
14+
15+
```bash
16+
memory-migrate inspect --input ./fixtures/cline-memory-bank
17+
```
18+
19+
Run a one-shot release demo:
20+
21+
```bash
22+
memory-migrate release --input ./fixtures/cline-memory-bank --to agents-md --profile agent-rules --output-dir ./dist/demo-release --zip ./dist/demo-release.zip
23+
```
24+
25+
Verify the release bundle:
26+
27+
```bash
28+
memory-migrate verify --manifest ./dist/demo-release/manifest.json
29+
```
30+
31+
## Useful fixture conversions
32+
33+
Convert generic JSON into Cursor rules:
34+
35+
```bash
36+
memory-migrate convert --input ./fixtures/generic-json/sample.json --to cursor-rules --profile developer-strict --output ./dist/cursor-rules
37+
```
38+
39+
Generate a doctor report from AGENTS instructions:
40+
41+
```bash
42+
memory-migrate doctor --input ./fixtures/agents-md --output ./dist/agents-doctor.json
43+
```

fixtures/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Fixtures
2+
3+
This directory contains official sample inputs for Agent Memory Bridge.
4+
5+
These fixtures are intended for:
6+
7+
- local demos
8+
- regression tests
9+
- adapter development
10+
- documentation examples
11+
12+
Available sample sets:
13+
14+
- `generic-json/`: simple canonical-friendly JSON list
15+
- `cline-memory-bank/`: Roo/Cline style Memory Bank
16+
- `agents-md/`: `AGENTS.md` plus `.agents/notes`
17+
- `cursor-rules/`: `.cursor/rules` instruction bundle
18+
- `claude-project/`: `CLAUDE.md` plus `.claude/memories`
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
If switching tools, preserve profile, decisions, and project context first.

fixtures/agents-md/AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# AGENTS
2+
3+
- Respect existing repository conventions.
4+
- Prefer deterministic outputs.
5+
- Keep migration artifacts auditable.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Release bundles should include compare, manifest, and verify artifacts.

fixtures/claude-project/CLAUDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# CLAUDE
2+
3+
This project migrates reusable memory between AI agent ecosystems.
4+
Focus on adapters, canonical schemas, and release-grade outputs.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Current focus: adapter coverage and release workflow.

0 commit comments

Comments
 (0)