Skip to content

docs: updated README.md#15

Merged
proDreams merged 2 commits intomainfrom
dev
Oct 25, 2025
Merged

docs: updated README.md#15
proDreams merged 2 commits intomainfrom
dev

Conversation

@proDreams
Copy link
Owner

No description provided.

@revu-agent
Copy link
Collaborator

  1. В README.md, в разделе про поддержку провайдеров, в строке
    * Поддержка **GitHub** **Gitea** и **Bitbucket** (расширение до GitLab, и др. в планах).
    отсутствует запятая между GitHub и Gitea, либо лучше добавить союз:
    Поддержка **GitHub**, **Gitea** и **Bitbucket**.
    Сейчас читается сливающе, нужно улучшить читаемость.

  2. В README.md, в секции с чек-листом, пометка [x] Bitbucket добавлена корректно, плюс указан автор за счёт чего внедрено — полезно.

  3. В README.md добавлен параметр окружения GIT_PROVIDER_REVIEWER с пояснением, что он актуален только для Bitbucket. Это хорошее дополнение, но стоит уточнить формат значения (например, “username в Bitbucket”).

  4. В примерах settings.yaml.example и settings.yaml.example_full у параметра GIT_PROVIDER_REVIEWER стоит двукратное объявление (в .example закомментировано одной строкой, а затем дублируется незакомментированное). Стоит оставить только одну строку, чтобы не вводить в заблуждение.

  5. В settings.yaml.example_full параметр GIT_PROVIDER_REVIEWER теперь добавлен с комментарием, что хорошо.

  6. В остальном исправления по документации выполнены корректно — описания понятные, форматирование выдержано, ошибок в тексте не замечено.

Резюме:

  • Исправить пункт 1 — добавить запятую или союз между "GitHub" и "Gitea".
  • Убрать дублирование параметра GIT_PROVIDER_REVIEWER в settings.yaml.example.
  • В описании переменной можно добавить формат значения (например, "строка — username пользователя в Bitbucket").

Остальное выполнено хорошо, проблем не обнаружено.

@revu-agent
Copy link
Collaborator

  1. В README.md: Формулировка "расширение до GitLab, и др. в планах" — запятая перед "и др." лишняя, лучше убрать для более гладкого чтения.
  2. В README.md: В списке TODO правильно выделено, что Bitbucket уже реализован, спасибо за указание автора.
  3. В README.md: Добавлен параметр GIT_PROVIDER_REVIEWER — хорошо, что указано, что он относится только к BitBucket, это важно для понимания.
  4. В настройках (settings.yaml.example и settings.yaml.example_full): Параметр GIT_PROVIDER_REVIEWER добавлен в пример, что полезно. Только в settings.yaml.example закомментированная строка с этим параметром осталась, а ниже такая же строка без комментария — это избыточно. Рекомендуется оставить только одну строку с комментарием, чтобы не путать пользователей.
  5. В целом изменения только документационные и конфигурные, код не затронут, багов, уязвимостей и проблем с производительностью нет.
  6. Стиль и форматирование соблюдены, кроме небольшой запятой из пункта 1.

Резюме:
✅ Документация обновлена корректно, мелкая рекомендация по удалению дублирующей строки с комментарием в settings.yaml.example.
Запятая в README перед "и др." желательно убрать.

@proDreams proDreams merged commit be7d64c into main Oct 25, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants