CONTRIBUTING.md

Contributing в model-debugger

Спасибо за интерес к проекту.

Локальный запуск

python -m venv .venv
source .venv/bin/activate
pip install -e .[dev]

Перед PR

1. Прогоните линтер:

ruff check .

2. Прогоните тесты:

pytest -q

3. Проверьте smoke-сценарий CLI:

python examples/generate_synthetic_data.py --rows 800 --seed 42 --output /tmp/sample_predictions.csv
python -m model_debugger \
  --input /tmp/sample_predictions.csv \
  --target y_true \
  --pred y_pred \
  --proba y_proba \
  --segments gender,region \
  --fairness-groups gender \
  --output /tmp/model-debugger-smoke

Рекомендации по изменениям

• Держите PR небольшими и сфокусированными.
• Для новых возможностей обновляйте README.md и/или doc-файлы.
• Для новых метрик добавляйте тесты на корректность и граничные случаи.
• Избегайте ломать публичный CLI без явной необходимости.

Коммиты

Рекомендуемый формат:

• feat: ...
• fix: ...
• docs: ...
• test: ...
• ci: ...

Язык общения

Проект ориентирован на русскоязычную аудиторию. Issues/PR желательно вести на русском.