Создание рекомендаций для участников репозитория

Сведения о рекомендациях по участию в разработке

Чтобы пользователи, участвующие в разработке проекта, могли качественно выполнять свою работу, добавьте файл с рекомендациями по внесению вклада в корневой каталог docs репозитория проекта или в папку .github. Когда кто-то открывает запрос на вытягивание или создает проблему, он увидит ссылку на этот файл. Ссылка на рекомендации по участию в разработке также отображается на странице contribute репозитория. Пример страницы contribute см. здесь: статье github/docs/contribute.

Для владельца репозитория рекомендации по участию в разработке представляют собой способ информирования о том, как люди должны вносить свой вклад.

Следуя рекомендация, участники могут быть уверены, что они отправляют правильно сформированные запросы на вытягивание и открывают полезные проблемы.

Как для владельцев, так и для участников, рекомендации по участию в разработке экономят время и силы, затрачиваемые на неправильное созданные запросы на вытягивание или проблемы, которые приходится отклонять и отправлять заново.

Добавление файлаCONTRIBUTING

1. На ваше предприятие перейдите на главную страницу репозитория. 1. Над списком файлов в раскрывающемся списке Добавить файл щелкните Создать файл.
2. Решите, где следует хранить рекомендации по участию в разработке: в корневом каталоге репозитория docs или в каталоге .github. Затем в поле имени файла введите имя и расширение файла. В именах файлов рекомендаций по участию в разработке не учитывается регистр. Файлы отображаются в виде форматированного текста, если расширение файла находится в поддерживаемом формате. Дополнительные сведения см. в разделе Работа с файлами, не связанными с кодом.
   • Чтобы сделать рекомендации по участию в разработке видимыми в корневом каталоге репозитория, введите CONTRIBUTING.
   • Чтобы сделать рекомендации по участию в разработке видимыми в каталоге docs репозитория, введите docs/ , чтобы создать каталог, а затем введите CONTRIBUTING.
   • Если репозиторий содержит несколько файлов CONTRIBUTING, файл, отображаемый по ссылкам, выбирается из расположений в следующем порядке: каталог .github, корневой каталог репозитория и, наконец, каталог docs.
3. Добавьте рекомендации по участию в разработке в новый файл. Это могут быть:
   • Действия по созданию полезных проблем или запросов на вытягивание.
   • Ссылки на внешнюю документацию, списки рассылки или правила поведения.
   • Ожидания сообщества и поведенческие ожидания.
4. В нижней части страницы введите короткое понятное сообщение о фиксации, описывающее внесенное в файл изменение. В таком сообщении фиксацию можно отнести к нескольким авторам. Дополнительные сведения см. в разделе Создание фиксации с несколькими авторами. 1. Под полями сообщения о фиксации укажите, куда следует добавить фиксацию: в текущую ветвь или в новую. Если текущей ветвью является ветвь по умолчанию, нужно создать новую ветвь для фиксации, а затем создать запрос на вытягивание. Дополнительные сведения см. в разделе Создание запроса на включение изменений. 1. Щелкните Предложить новый файл

Примеры рекомендаций по участию в разработке

Если вы в замешательстве, вот несколько хороших примеров рекомендаций:

• Рекомендации по вкладу в GitHub Docs.
• Рекомендации по участию в разработке для Ruby on Rails.
• Рекомендации по участию в разработке для Open Government.

Дополнительные материалы

• Раздел "Начало разработки проекта с открытым кодом" руководства по проектам с открытым кодом