Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (61 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

90 lines (61 loc) · 1.49 KB

Contributing to Agent FS

Thanks for your interest in contributing to Agent FS!

Table of Contents

Development Setup

Prerequisites

  • Bun v1.2+
  • Git

Install Dependencies

git clone https://github.com/desplega-ai/agent-fs.git
cd agent-fs
bun install

Running the Project

Tests

# Run all tests
bun run test

# With coverage
bun run test:coverage

Build

# Bundle CLI for npm
bun run build

Output: packages/cli/dist/cli.js

Code Quality

Type Checking

bun run typecheck

Run this before committing to catch type errors early.

Project Structure

agent-fs/
├── packages/
│   ├── core/           # Core library — storage, search, identity, database
│   ├── cli/            # CLI binary (agent-fs)
│   ├── mcp/            # MCP server integration
│   └── server/         # HTTP server (Hono)
├── scripts/            # Release scripts
├── package.json        # Workspace root
└── tsconfig.json

Submitting Changes

  1. Fork the repo
  2. Create a branch (git checkout -b my-feature)
  3. Make your changes
  4. Run bun run typecheck and bun run test
  5. Open a PR

Join our Discord if you have questions or want to discuss ideas.