Руководства для проектов

Шаблон CONTRIBUTING.md для открытого репозитория

Файл CONTRIBUTING.md помогает перейти от «Я хочу помочь» к полезному сообщению о проблеме или запросу на слияние. Объясните минимальный поддерживаемый вклад и способ его проверки. Требования должны отражать реальную работу проекта, а не амбициозный процесс, которому никто не следует.

Редакция GitHubStart · Обновлено

Скопируйте и адаптируйте шаблон участия

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

# Участие в проекте

## Перед началом
Прочитайте README и проверьте существующие обсуждения проблем.
Для крупных изменений обсудите подход до реализации.

## Локальная настройка
[Необходимая среда выполнения и проверенные команды настройки]

## Сообщить об ошибке
Укажите версию, окружение, шаги, ожидаемый и фактический результат.
Удалите секреты и персональные данные из журналов.

## Отправить запрос на слияние
- Объясните проблему и предлагаемое изменение.
- Сохраняйте узкую направленность изменения.
- Выполните [проверки, предусмотренные проектом].
- Обновите затронутую документацию.

## Рецензирование
[Кто проверяет, как отвечать и реальная доступность]

## Другие способы помочь
[Документация, примеры, переводы или воспроизводимые сообщения о проблемах]

Сделайте правила легко доступными

GitHub распознаёт правила участия в корне репозитория, в каталогах docs или .github. Добавьте ссылку на файл и в README, чтобы читатель введения сразу нашёл порядок работы.

Проверьте путь от реальных точек входа для участников в репозитории. Если файлов с правилами несколько, устраните противоречащие инструкции. Участник не должен видеть одну команду настройки в README и другую, неподдерживаемую, в руководстве по участию.

Подготовьте одну доступную задачу для первого вклада

Выберите небольшую задачу с понятным результатом, например исправление примера для поддерживаемой среды выполнения. Объясните, как воспроизвести проблему, какое поведение должно измениться и как проверить завершение. Не называйте задачу подходящей для новичков, если она требует незадокументированных внутренних знаний.

Честно укажите свою доступность для проверки. Если не можете обещать срок ответа, объясните, как участникам узнать статус. Чёткие границы уменьшают объём брошенной работы и полезнее обещаний принять любой вклад.

Частые вопросы

Заменяет ли CONTRIBUTING.md файл README.md?

Нет. README объясняет проект и его использование. Правила участия объясняют, как предлагать и проверять изменения.

Нужно ли копировать команды тестирования из другого проекта?

Только если эти команды подходят и вашему проекту. Заменяйте заполнители командами, которые вы действительно проверили.

Гарантируют ли правила участия больше участников?

Нет. Они уменьшают неопределённость для заинтересованных людей, но полезность проекта, качество задач и дальнейшая работа сопровождающих по-прежнему важны.

Источники