Настройка рекомендаций по написанию кода для проверки кода GitHub Copilot

См . раздел AUTOTITLE.

Рекомендации по написанию кода

Вы можете предоставить Copilot с набором рекомендаций по программированию, написанных на естественном языке, которые помогут вам просмотреть код таким образом, чтобы он соответствовал стилю написания кода и рекомендациям вашей организации. Дополнительные сведения, включая примеры рекомендаций по программированию, см. в разделе Рекомендации по написанию кода для проверки кода GitHub Copilot.

Создание руководства по написанию кода

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

2. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

   

3. В разделе "Код и автоматизация" боковой панели щелкните Copilot, а затем проверка кода.

4. Нажмите кнопку " Создать руководство".

5. В разделе "Имя" укажите руководство по написанию кода.

6. В разделе "Описание" укажите описание руководства по программированию до 600 символов длиной. Это будет использоваться Copilot для понимания стиля написания кода и принятия решения о том, когда следует оставить комментарий.

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

7. При необходимости ограничьте руководство по написанию кода определенным типам файлов или путям, нажав кнопку "Добавить путь к файлу" и добавив шаблоны путей.

   Синтаксис можно использовать fnmatch для определения путей к целевому объекту с * подстановочным знаком для сопоставления любой строки символов.

   Так как GitHub использует File::FNM_PATHNAME флаг для синтаксиса File.fnmatch , * подстановочный знак не соответствует разделителям каталогов (/). Например, будет соответствовать всем ветвям, qa/* начинающимся с qa/ и содержащим одну косую черту, но не совпадать qa/foo/bar. Вы можете включить любое количество косых черт после qa qa/**/*, которое будет соответствовать, например qa/foo/bar/foobar/hello-world. Можно также расширить qa строку, qa**/**/* чтобы сделать правило более инклюзивным.

   Дополнительные сведения о параметрах синтаксиса см. в документации по fnmatch.

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

   1. Нажмите кнопку "Добавить пример".
   2. Добавьте собственный пример или нажмите Создайте пример кода для автоматического создания примера кода на основе названия и описания.
   3. Нажмите кнопку "Сохранить", чтобы сохранить пример кода.
   4. Проверьте руководство по написанию кода для примера, нажав клавиши Run.

9. Сохраните руководство по написанию кода и включите его, нажав кнопку "Сохранить руководство".