Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (50 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

60 lines (50 loc) · 1.18 KB

Contributing to RepoMemory

Thanks for contributing. RepoMemory exists to stop repeated mistakes across coding-agent sessions.

Prerequisites

  • Node.js 20+
  • npm
  • Git

Setup

git clone https://github.com/Lay4U/repomemory.git
cd repomemory
npm install

Validation

Run before opening a PR:

npm run typecheck
npm test
npm run build

Contribution Guidelines

  • Keep each PR focused on one objective.
  • Add tests for behavior changes.
  • Update docs when CLI or MCP behavior changes.
  • Prefer explicit typing at module boundaries.
  • Avoid unnecessary dependencies.

PR Checklist

  • Clear problem statement
  • Concise solution summary
  • Tradeoffs/limitations
  • Test evidence (commands + results)
  • Linked issue when relevant

Bug Reports

Please include:

  • RepoMemory version
  • Node.js version
  • Operating system
  • Exact command(s) run
  • Expected vs actual behavior
  • Minimal reproduction

Feature Requests

Please describe:

  • Current workflow pain
  • Desired behavior
  • Why existing tools are insufficient
  • Expected impact on agent handoffs

Security

Report security issues privately to maintainers.

License

By contributing, you agree contributions are MIT-licensed.