Перейти к содержанию

Как внести свой вклад в chutils

Мы рады, что вы хотите помочь проекту! Любой вклад очень ценен.

Этот документ содержит набор рекомендаций по участию в проекте chutils.

Кодекс поведения

Прежде всего, пожалуйста, ознакомьтесь с нашим Кодексом поведения. Мы ожидаем, что все участники будут ему следовать.

Как можно помочь?

Сообщения об ошибках

  • Убедитесь, что ошибка еще не была зарегистрирована, проверив раздел Issues.
  • Если вы не нашли похожей проблемы, создайте новый issue. Обязательно включите в него четкое название, описание, и, если возможно, небольшой пример кода для воспроизведения ошибки.

Предложения по улучшению

  • Создайте новый issue с вашим предложением. Подробно опишите, какую проблему решает ваше улучшение и как оно должно работать.

Pull Requests

Мы рады вашим pull request'ам! Вот как это сделать правильно:

  1. Сделайте форк репозитория.
  2. Создайте новую ветку для ваших изменений (git checkout -b feature/amazing-feature).
  3. Внесите изменения и напишите тесты для них, если это необходимо.
  4. Убедитесь, что все тесты проходят.
  5. Отправьте pull request в ветку main нашего репозитория.

Настройка окружения для разработки

  1. Клонируйте ваш форк репозитория: bash git clone https://github.com/ВАШ_НИК/chutils.git

  2. Перейдите в папку проекта: bash cd chutils

  3. Установите зависимости с помощью Poetry: bash poetry install

Тестирование и документация

  • Запуск тестов: bash poetry run pytest

  • Просмотр документации локально: bash poetry run mkdocs serve

Стиль кода и коммитов

  • Стиль кода: Мы стараемся придерживаться стандартов PEP 8. Пожалуйста, убедитесь, что ваш код им соответствует.
  • Docstrings: Вся документация в коде пишется в Google-стиле. Пожалуйста, следуйте ему.
  • Коммиты: Мы используем Conventional Commits. Это помогает нам поддерживать историю изменений чистой и понятной. Пример: feat(config): добавить поддержку формата .toml или fix(logger): исправить ошибку ротации логов

Спасибо за ваш вклад!