Open-source repositories
PromptGuard maintains several public repositories. These are the best places to contribute code, report bugs, or suggest improvements.| Repository | Language | What it is |
|---|---|---|
| promptguard-python | Python | Python SDK (promptguard-sdk on PyPI) |
| promptguard-node | TypeScript | Node.js SDK (promptguard-sdk on npm) |
| promptguard-cli | Rust | CLI tool and MCP server |
| promptguard-vscode | TypeScript | VS Code extension |
| promptguard-cursor | Markdown | Cursor plugin (rules and skills) |
CONTRIBUTING.md with setup, testing, and PR guidelines specific to that project.
How to contribute
Report a bug or request a feature
Open an issue on the relevant repository above. Include:- What you expected vs what happened
- Steps to reproduce
- Your environment (OS, language version, SDK version)
Submit a pull request
- Fork the repository
- Create a feature branch from
main - Follow the
CONTRIBUTING.mdin that repository for setup and testing - Submit a PR with a clear description of the change
Improve documentation
If you find an error or gap in these docs, open an issue on any of the repositories above or email docs@promptguard.co. We review all suggestions and update docs regularly.Documentation structure
These docs follow the Diataxis framework:| Type | Purpose | Example |
|---|---|---|
| Tutorial | Step-by-step learning experience | Tutorial |
| Guide | How to accomplish a specific task | Node.js Guide |
| Reference | Factual description of an API or tool | API Reference |
| Explanation | Why something works the way it does | Threat Detection |
Writing conventions
When suggesting documentation improvements, follow these conventions:- Use second person (“you”, not “we” or “the user”)
- Use active voice (“Configure the SDK” not “The SDK can be configured”)
- Lead with the action (“Run
npm install” not “You should runnpm install”) - Keep paragraphs short (3-4 sentences max)
- Always specify code block language:
```python,```javascript,```bash - Include both Python and Node.js examples when showing SDK usage
Questions?
- General questions: support@promptguard.co
- Security issues: security@promptguard.co (do not open public issues for vulnerabilities)