Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
- main
pull_request:

permissions:
contents: read

jobs:
test:
runs-on: ubuntu-latest
Expand All @@ -26,6 +29,9 @@ jobs:
- name: Source tests
run: npm run test:src:readonly

- name: Markdown links
run: npm run check:links

- name: Memory lint
run: npm run lint:memory

Expand Down
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

All notable changes to this project will be documented in this file.

## [0.7.0] - 2026-08-09

- Rebuilt the README around a one-command start, concrete before/after proof, agent compatibility, safety boundaries, and a shareable product visual.
- Added `deja-vu init --merge-agents` to append an idempotent rules block without replacing an existing `AGENTS.md`.
- Made `init` report incomplete setup and made `doctor` reject an `AGENTS.md` that lacks Deja Vu recall rules.
- Added cross-platform starter-kit instructions and a contributor guide.
- Added repository-wide local Markdown link validation and fixed broken memory-index template links.
- Hardened package verification to use an isolated npm cache and prepared the package metadata for the first CLI-capable npm release.

## [0.6.0] - 2026-05-17

- Reworked the README first screen around the "3-file memory system" positioning.
Expand Down
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Contributing to Deja Vu

Thanks for helping make project memory simpler and safer for coding agents.

## Product boundary

Deja Vu is protocol-first:

- the three-file starter kit is the main product
- Markdown and JSONL remain canonical and human-readable
- the CLI is an optional helper
- the TypeScript engine is an optional scale-up layer

Changes should reduce repeated explanation, recall cost, or memory noise without turning the base product into a hosted service or heavy framework.

## Before opening a pull request

1. Keep the change focused and explain the user problem it solves.
2. Add or update tests for behavior changes.
3. Keep public examples sanitized; never add secrets, PII, raw transcripts, or private project facts.
4. Run the relevant verification:

```bash
npm ci
npm run test:src:readonly
npm run check:links
npm run lint:memory
npm run report:feedback
npm test
```

`npm test` rebuilds `dist` and runs npm package verification. `npm run test:src:readonly` is the read-only source-test path.

## Good first contributions

- clearer starter-kit instructions
- compatibility notes backed by actual agent behavior
- safer memory lint rules with low false-positive rates
- small, sanitized protocol examples
- documentation fixes and reproducible bug reports

For larger protocol or architecture changes, open an issue first so the behavior and compatibility impact can be discussed before implementation.
Loading
Loading