Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (50 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

70 lines (50 loc) · 2.25 KB
Raw

Contributing to Personal Agent Template

Thank you for your interest in contributing!

Reporting Bugs

  • Search existing issues before opening a new one
  • Include steps to reproduce, expected behavior, and actual behavior
  • Include your environment (Node version, OS, browser)
  • Use the bug report template

Suggesting Features

  • Open a feature request
  • Describe the use case and why it would be valuable for a template (reusable by many forks)
  • If possible, outline a proposed implementation

Development Setup

git clone https://github.com/vercel-labs/personal-agent-template.git
cd personal-agent-template

pnpm install
cp .env.example .env
pnpm db:migrate
pnpm dev

Set real values in .env. Never commit secrets or .data/.

Project Structure

personal-agent-template/
├── agent/          # Eve agent: channels, tools, skills, connections
├── app/            # Nuxt 4 UI: chat, settings, profile
├── server/         # Nitro API, Drizzle schema, auth, memory
├── shared/         # Types and helpers used by app + agent
└── docs/           # Documentation (architecture, env, customization)

Making Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feat/my-feature)
  3. Make your changes
  4. Run checks: 
    pnpm typecheck
  5. Commit with a Conventional Commits message
  6. Open a pull request

Pull Request Process

  1. Ensure pnpm typecheck passes
  2. Update documentation if your change affects user-facing behavior
  3. Add a clear description of what changed and why
  4. Link related issues when applicable

PR titles must follow Conventional Commits (enforced by CI). Scopes: app, agent, server, docs, deps.

Customizing the Template

If you are forking for your own agent (not contributing upstream), see docs/CUSTOMIZATION.md.

License

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