mirror of https://github.com/rohitg00/agentmemory.git synced 2026-09-14 20:16:33 +08:00

Files

T

Rohit Ghumare 76c96cef0c docs: address CodeRabbit review on governance docs

- CODE_OF_CONDUCT.md: add an external escalation fallback chain for
  reports that concern the only active Maintainer or where every
  listed Maintainer recuses. Routes to the Contributor Covenant
  ombudsperson, a future hosting foundation's conduct committee, or
  GitHub Trust & Safety — so no report dead-ends.
- SECURITY.md: drop the 'do not encrypt' advice. GHSA is the
  preferred channel; email is now framed as an encrypted-only
  fallback with explicit GPG / SSH key publication URLs for
  reporters who need end-to-end confidentiality.
- SECURITY.md: grammar fix — 'after a new minor is released'.
- CONTRIBUTING.md: replace brittle '777+ tests' with 'the full test
  suite'; keep the integration-test exception.
- GOVERNANCE.md: replace placeholder link label with a plain
  'release process' label.
- MAINTAINERS.md: drop the contributor shortlist — premature to
  name future Maintainer candidates before they've been through the
  formal process. Keep the contributor-graph link for transparency.

2026-04-18 20:35:02 +01:00

5.3 KiB

Raw Permalink Blame History

Contributing to agentmemory

Thanks for taking an interest. This file is the short path from "I have an idea" to "it's in main."

Ground rules

Apache-2.0 license applies to every contribution.
Sign-off is required on every commit (see DCO below).
Be civil. CODE_OF_CONDUCT.md applies.
No attribution headers ("Generated with Claude Code", "Co-Authored-By: Claude", etc.) in commits or PR descriptions.

Before you open an issue

Search existing issues first:

If it's a bug: provide the repro steps, your Node version, OS, agentmemory version (npm view @agentmemory/agentmemory version), and what you expected vs. what you saw.

If it's a feature: describe the user problem before the implementation. "I couldn't X because Y" beats "please add X."

Before you open a PR

Fork the repo and create a branch off main:
- feat/<short-name> for features
- fix/<issue-number>-<short-name> for bug fixes
- docs/<topic>, refactor/<topic>, chore/<topic> for the rest
npm install — you need Node >=20.
npm run build — TypeScript must compile clean.
npm test — the full test suite must pass. The one integration test under test/integration.test.ts needs a live server on :3111 and is fine to skip locally.
Commit with sign-off. Rebase over tiny fixup commits so the history stays readable.

Pull request flow

Keep PRs small and focused. One logical change per PR.
Write a clear description: what it does, why, and how to verify.
Link the issue the PR resolves (Fixes #NNN / Closes #NNN).
Expect CodeRabbit to review automatically. Address its comments before asking a human.
Address review feedback in new commits (do not force-push to the same branch). Maintainers may squash on merge.
A maintainer will merge when tests pass, CodeRabbit is green, and any review comments are addressed.

Developer Certificate of Origin

Every commit must carry a Signed-off-by trailer stating you have the right to submit the contribution under Apache-2.0. The full text of the DCO is at https://developercertificate.org.

Add it automatically:

git commit -s -m "feat: your message"

PRs with commits lacking sign-off will not merge.

Coding style

TypeScript strict mode. No any unless justified in a comment.
Prettier-compatible formatting (editor on save is fine; no repo-wide hook).
No code comments that restate what the code does. Only write a comment when the why is non-obvious — a hidden constraint, an invariant, a workaround for a specific bug.
No dead code, no commented-out imports.
Tests live next to the feature in test/<feature>.test.ts. Name the test after the behavior, not the implementation.

Subsystems at a glance

Directory	What lives here
`src/triggers/api.ts`	Every HTTP endpoint under `/agentmemory/*`. Adding an MCP tool? Add the REST twin here too.
`src/mcp/`	Standalone MCP server (`@agentmemory/mcp`), tools registry, transport, in-memory KV.
`src/functions/`	Core memory operations — observe, compress, consolidate, retention, forget, graph, smart-search, export-import, governance.
`src/hooks/`	The 12 auto-hooks that capture sessions in agents.
`src/health/`	Liveness + readiness + alert thresholds.
`src/state/`	KV schema, keyed mutex, access log.
`integrations/`	First-party plugins: `hermes/`, `openclaw/`, `filesystem-watcher/`.
`plugin/`	Claude Code plugin (`agentmemory@agentmemory`).
`website/`	Marketing site (Next.js 16).
`test/`	Vitest test suite.

Adding an MCP tool

Register the function in src/functions/<area>.ts.
Register the HTTP trigger in src/triggers/api.ts with a matching api_path.
Add the tool entry in src/mcp/tools-registry.ts.
Implement in src/mcp/standalone.ts if the standalone MCP package should also expose it.
Write a test under test/.
No CHANGELOG touch in the PR itself — release PRs are the only place CHANGELOG changes.

Adding an auto-hook

Add the new HookType string to the union in src/types.ts.
Wire the handler in src/hooks/<hook-name>.ts.
Add a Vitest case that fires the hook and asserts the observation gets written.

Release process

Maintainers cut releases. Every bump touches 8 files in lockstep:

package.json
package-lock.json (top + packages[""].version)
plugin/.claude-plugin/plugin.json
packages/mcp/package.json (self + ~x.y.z pin on the main package)
src/version.ts (extend the union, assign)
src/types.ts (ExportData.version union)
src/functions/export-import.ts (supportedVersions Set)
test/export-import.test.ts (assertion)

Then: CHANGELOG section, PR, merge, tag, GitHub release. The Publish to npm workflow picks up the release trigger and publishes @agentmemory/agentmemory, @agentmemory/mcp, and @agentmemory/fs-watcher to npm with provenance.

Security issues

Do not open a public issue for a security report. See SECURITY.md.

Questions

Implementation questions: open a GitHub Discussion.
Governance questions: open an issue labeled governance. See GOVERNANCE.md.

5.3 KiB Raw Permalink Blame History