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

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

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

          Если в вашем репозитории есть `CONTRIBUTING.md` файл, GitHub он также показывает его в двух других местах, чтобы участникам было проще его находить:

• Вкладка « Вклад» в обзоре репозитория (рядом с « README» и « Кодексом поведения»)
• Ссылка «Вклад» в боковой панели репозитория

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

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

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

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

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

1. На GitHubперейдите на главную страницу репозитория.

2. Над списком **** файлов выберите раскрывающееся меню , а затем щелкните Создать новый файл.

   Кроме того, можно щелкнуть в представлении дерева файлов слева.

   

3. Решите, где следует хранить рекомендации по участию в разработке: в корневом каталоге репозитория docs или в каталоге .github. Затем в поле имени файла введите имя и расширение файла. В именах файлов рекомендаций по участию в разработке не учитывается регистр. Файлы отображаются в виде форматированного текста, если расширение файла находится в поддерживаемом формате. Дополнительные сведения см. в разделе Работа с файлами, не связанными с кодом.

   • Чтобы сделать рекомендации по участию в разработке видимыми в корневом каталоге репозитория, введите CONTRIBUTING.
   • Чтобы сделать рекомендации по участию в разработке видимыми в каталоге docs репозитория, введите docs/, чтобы создать каталог, а затем введите CONTRIBUTING.
   • Если репозиторий содержит несколько файлов CONTRIBUTING, файл, отображаемый по ссылкам, выбирается из расположений в следующем порядке: каталог .github, корневой каталог репозитория и, наконец, каталог docs.

4. Добавьте рекомендации по участию в разработке в новый файл. Это могут быть:

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

5. Нажмите кнопку " Зафиксировать изменения" ...

6. В поле "Фиксация сообщения" введите короткое понятное сообщение фиксации, описывающее изменения, внесенные в файл. В таком сообщении фиксацию можно отнести к нескольким авторам. Дополнительные сведения см. в разделе Создание фиксации с несколькими авторами.

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

   

8. Нажмите кнопку Зафиксировать изменения или Предложить изменения.

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

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

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

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

• Раздел Open Source Guides : Начало проекта с открытым исходным кодом
• GitHub Skills
• Добавление лицензии в репозиторий