Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (31 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.57 KB

Contributing to git-fleet

Thanks for contributing! This repo is intentionally small and focused: it is primarily a collection of GitHub Copilot custom agent definitions plus a few helper scripts.

Ways to contribute

  • Add a new agent definition (*.agent.md)
  • Improve an existing agent definition (clarity, safety rules, correctness)
  • Add/maintain supporting scripts (keep changes minimal and testable)
  • Improve documentation

Repo layout

  • agents/: Catalog of agent definitions (easy to browse)
  • .github/agents/: Workspace-shared agents (VS Code discovers agents here)
  • scripts/: Helper scripts (e.g., Letta Cloud agent creation)

Development setup (Python)

Preferred: uv.

  • Create a virtual env and install dependencies from requirements.txt
  • Copy .env.example to .env and fill in required values

Security note: Do not commit secrets. Treat API keys (e.g., LETTA_API_KEY) as secrets at all times.

Contribution workflow

  1. Fork the repo
  2. Create a feature branch
  3. Make a small, focused change
  4. Update README.md if you add a new agent
  5. Open a pull request

Agent authoring guidelines

  • Include YAML front matter in every *.agent.md (name, description, target, etc.)
  • Do not invent SDK APIs: if an integration is uncertain, document the assumption or add a reference
  • Prefer stateful agent patterns for Letta (send only new user messages; don’t resend full history)
  • Keep instructions explicit about secret handling

Style

  • Keep docs concise and skimmable
  • Prefer bullet lists and short sections
  • Avoid large refactors unless requested