Thank you for your interest in contributing! Here are some guidelines to help you get started:
- Fork the repository and create your branch from
main. - Make your changes and write clear, descriptive commit messages.
- Ensure your code passes existing tests and lints. Add new tests as appropriate.
- Open a pull request with a clear description of what you’ve changed and why.
- Use consistent code style (see existing code for reference).
- Prefer TypeScript for new features or enhancements.
- Keep functions and components small and focused.
- Register new AI backends through the pluggable provider registry (
src/utils/providers.ts) instead of hard-coding API calls. - Keep the human-in-the-loop safety check intact when adding any feature that can execute code or commands.
- Use Node.js 20.x (npm 10.x) to match CI.
- Install dependencies with
npm run install:all. - Build shared types first:
npx tsc --build src/types. - Run the full build:
npm run build:all. - Run linting:
npm run lint:all.
- Search existing issues before opening a new one.
- Provide detailed steps to reproduce the problem.
- Include screenshots or code snippets if helpful.
By participating, you agree to abide by our Code of Conduct.
- Starter prompts live in
assets/blueprints/best-practice-prompts.json. Feel free to add concise, well-tagged blueprints (no secrets, no PII). - Keep templates reusable by leveraging the variable syntax (
{{variable}}) supported in the prompt editor preview.
Thank you for helping improve Master-Prompt-Editor!