Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (36 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.46 KB

Contributing to @pons/module-agent

Thanks for your interest in contributing!

Prerequisites

Development Setup

git clone https://github.com/usepons/module-agent.git
cd module-agent
deno install

Running Locally

# Run the agent module
deno run -A runner.ts

The agent module depends on the LLM module for text generation — run both alongside the kernel and gateway for full integration testing. Test the agent loop by sending messages through the gateway WebSocket.

Code Style

  • Pure Deno — no npm build tools
  • Explicit import specifiers: jsr:@pons/sdk@^0.2
  • No bare imports
  • Run deno fmt before committing
  • Run deno lint to catch issues

Module Structure

  • Agent definitions live in the workspace agents/ directory — each agent has agent.yaml, soul.md, and agent.md
  • Skills are loaded from the workspace skills/ directory
  • The agent loop is in src/loop.ts, context assembly in src/context.ts

Submitting Changes

  1. Fork the repository
  2. Create a branch from main (feat/new-hook, fix/session-cleanup)
  3. Make focused, atomic commits
  4. Test locally — run the full agent loop end to end
  5. Open a pull request against main

Reporting Issues

Open an issue at github.com/usepons/module-agent/issues.

License

By contributing, you agree that your contributions will be licensed under the MIT License.