Skip to content

Commit 414c2d5

Browse files
mldangeloclaude
andauthored
docs: add CONTRIBUTING, CODE_OF_CONDUCT, and SECURITY files (#32)
All three redirect to promptfoo/promptfoo as the primary project. CONTRIBUTING includes minimal setup instructions specific to this pip wrapper for issues scoped to the Python shim itself. Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 5e0bd39 commit 414c2d5

File tree

3 files changed

+58
-0
lines changed

3 files changed

+58
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code of Conduct
2+
3+
This project follows the same Code of Conduct as the main promptfoo project.
4+
5+
Please read and follow it: **[github.com/promptfoo/promptfoo/blob/main/CODE_OF_CONDUCT.md](https://github.com/promptfoo/promptfoo/blob/main/CODE_OF_CONDUCT.md)**

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
## Contributing to promptfoo
4+
5+
For contributions to promptfoo itself — new features, providers, bug fixes, and documentation — please go to the main project:
6+
7+
**[github.com/promptfoo/promptfoo](https://github.com/promptfoo/promptfoo)**
8+
9+
## Contributing to this pip wrapper
10+
11+
This repository is only the thin Python shim that lets people install promptfoo via `pip`. Issues here should be about:
12+
13+
- Installation failures via pip
14+
- Node.js detection or environment problems
15+
- Python shim behaviour on Windows/macOS/Linux
16+
17+
### Setup
18+
19+
Requires Python 3.9+, Node.js 20+, and [uv](https://github.com/astral-sh/uv).
20+
21+
```bash
22+
git clone https://github.com/promptfoo/promptfoo-python.git
23+
cd promptfoo-python
24+
uv sync --extra dev
25+
uv run pytest -m 'not smoke' # fast unit tests
26+
uv run pytest # all tests (requires Node.js)
27+
```
28+
29+
### Submitting changes
30+
31+
1. Branch from `main`
32+
2. Follow [Conventional Commits](https://www.conventionalcommits.org/) — release-please uses commit messages to version and changelog automatically
33+
3. Run checks before opening a PR:
34+
```bash
35+
uv run ruff check src/ --fix && uv run ruff format src/
36+
uv run mypy src/promptfoo/ && uv run pyright src/promptfoo/
37+
uv run pytest -m 'not smoke'
38+
```
39+
4. Open a pull request against `main`

SECURITY.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Security Policy
2+
3+
## Reporting a vulnerability
4+
5+
Please follow the security policy of the main promptfoo project for reporting vulnerabilities:
6+
7+
**[github.com/promptfoo/promptfoo/blob/main/SECURITY.md](https://github.com/promptfoo/promptfoo/blob/main/SECURITY.md)**
8+
9+
## Scope
10+
11+
- **This repository**: issues with the Python pip wrapper (installation, shim behaviour, CI integration)
12+
- **promptfoo features and security**: report to [promptfoo/promptfoo](https://github.com/promptfoo/promptfoo)
13+
14+
Do not open public GitHub issues for security vulnerabilities. Follow the responsible disclosure process linked above.

0 commit comments

Comments
 (0)