Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (43 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 1.72 KB

Contributing

Thanks for your interest in BetterPrompt! Here's how to get started.

Development Setup

git clone https://github.com/onlycastle/BetterPrompt.git
cd BetterPrompt
npm install
npm run dev

The plugin (packages/plugin) works standalone without any API keys.

Project Structure

Directory What it does
packages/plugin/ Claude Code plugin (MCP tools + analysis skills)
app/ Next.js app router (team dashboard)
src/components/ React components
src/lib/ Models, parser, persistence, and domain logic
tests/ Unit, integration, and E2E tests

Making Changes

  1. Create a branch from main.
  2. Make your changes.
  3. Run the checks below.
  4. Open a pull request.

Verification

Run before opening a PR:

npm run typecheck   # TypeScript compilation check
npm run lint        # ESLint
npm test            # Unit tests
npm run build       # Production build

Guardrails

  • Do not commit .env files, generated caches, or session transcripts.
  • Do not add hardcoded production URLs, webhook endpoints, or API keys.
  • Prefer local-first behavior and make hosted integrations opt-in.

Code Style

  • TypeScript strict mode is enabled.
  • ESLint enforces style rules -- run npm run lint to check.
  • Keep LLM prompts and all code in English (see CLAUDE.md language policy).

Reporting Issues