much-data/kwork-api
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: add E2E testing instructions to CONTRIBUTING.md

Browse Source
This commit is contained in:
root 2026-03-29 01:36:11 +00:00
parent 8cb0a59063
commit 552e937434
1 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@ -23,7 +23,7 @@ Generate documentation locally:
```bash ```bash
# Install docs dependencies # Install docs dependencies
uv sync --group dev uv sync --group docs
# Build HTML docs # Build HTML docs
uv run mkdocs build uv run mkdocs build
@ -32,7 +32,31 @@ uv run mkdocs build
uv run mkdocs serve uv run mkdocs serve
``` ```
Documentation is built automatically by CI and available in `site/` folder. Documentation is built automatically by CI.
---
## End-to-End Testing
E2E тесты требуют реальных credentials Kwork.ru:
```bash
# 1. Скопируй шаблон
cp tests/e2e/.env.example tests/e2e/.env
# 2. Заполни credentials
nano tests/e2e/.env # KWORK_USERNAME, KWORK_PASSWORD
# 3. Запусти тесты
uv run pytest tests/e2e/ -v
# С задержками (rate limiting)
uv run pytest tests/e2e/ -v --slowmo=1
```
⚠️ **Не запускай E2E в CI** — только локально с тестовым аккаунтом!
См. [tests/e2e/README.md](tests/e2e/README.md) для деталей.
## Branch Naming ## Branch Naming