Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (33 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.65 KB

Contributing to MIF

Adapter Contributions

The most impactful way to contribute is writing adapters for memory systems. An adapter converts a system's native format to/from MIF.

Writing an Adapter

Python: Add a new adapter class in python/mif/adapters.py that extends MifAdapter. TypeScript: Add a new adapter class in npm/src/adapters.ts that implements MifAdapter.

Each adapter must implement:

  • name() / format_id() — identifier and human-readable name
  • detect(data) — return True if this adapter can handle the input
  • to_mif(data) — convert external format to MifDocument
  • from_mif(doc) — convert MifDocument to external format

Register the adapter in python/mif/registry.py and npm/src/index.ts.

Validate output against schema/mif-v2.schema.json.

Adapter Guidelines

  • Map system-specific fields to MIF core fields where possible
  • Put system-specific metadata in vendor_extensions
  • Preserve unknown fields on round-trip
  • Handle partial data gracefully (not all systems have all fields)

Spec Changes

For changes to the core specification:

  1. Open an issue describing the problem and proposed solution
  2. Discuss with maintainers before submitting a PR
  3. Changes must be backward-compatible (additive only)
  4. Include rationale for any new required fields

Validation

All example files must validate against the JSON Schema:

# Using ajv-cli
npx ajv validate -s schema/mif-v2.schema.json -d examples/minimal.mif.json
npx ajv validate -s schema/mif-v2.schema.json -d examples/full.mif.json

Code of Conduct

Be respectful. This is a collaborative effort to solve memory portability for everyone.