52 lines (37 loc) · 1.34 KB

Contributing to PromptLoop

Thanks for your interest in contributing! PromptLoop is MIT licensed and welcomes contributions.

Getting Started

git clone https://github.com/cscull/PromptLoop.git
cd PromptLoop
npm install
npm run build
npm link  # makes `promptloop` available globally

Copy .env.example to .env and add your LLM API key.

Development

npm run dev    # watch mode — recompiles on changes
npm run build  # one-time build

The CLI entry point is src/cli.ts. Each command lives in src/commands/.

Areas for Contribution

New LLM providers — add a case to the switch in src/lib/llm.ts
Evaluation strategies — pluggable evaluator interface (coming soon)
Bug fixes and improvements — open an issue first for discussion
Documentation — README improvements, examples, tutorials

Pull Requests

Fork the repo and create a branch from main
Make your changes and ensure npm run build succeeds
Write a clear PR description explaining what and why
Keep PRs focused — one feature or fix per PR

Reporting Issues

Open a GitHub issue with:

What you expected to happen
What actually happened
Steps to reproduce
Your Node.js version and OS

Code Style

TypeScript strict mode
ESM imports (not CommonJS)
No unnecessary abstractions — keep it simple