Модерация кода и документации

[Chimildic]

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

Первая правка

1. Перейдите в онлайн версию редактора VS Code. Нажмите кнопку открытие репозитория. Скопируйте ссылку https://github.com/Chimildic/goofy в поле, нажмите open github repository.

   

   Разрешите авторизацию через GitHub

   

2. Внизу нажмите на ветку main

   

   В меню выберите create new branch (создать новую ветку), затем напишите ее название, например, patch. После подтверждения появится уведомление, нажмите кнопку switch to branch.

   

3. Выберите в боковом меню проводник. Перемещайтесь по файлам, чтобы внести свою правку.

   

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

4. Выберите в боковом меню систему контроля версий (1). Обновите кэш (2). Выберите файлы, изменения в которых нужно применить (3). Напишите краткий комментарий, описывающий суть коммита (4). Сохраните коммит нажав на галку

   

5. Зайдите в список своих репозиториев на GitHub

   

   Перейдите в репозиторий goofy (это ваша копия или форк). Выберите ветку, которую создавали вначале (patch).

   

   Нажмите contribute, затем open pull request. Добавьте заголовок, нажмите create pull request.

   

Ваша правка отправлена на рассмотрение

Вторая правка

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

1. Зайдите в вашу копию репозитория и получите последние изменения (кнопка fetch upstream)

   

2. В VS Code переключите ветку на main, если выбрана другая. Для этого внизу нажмите на текущую ветку и в меню выберите main.

3. Синхронизируйте изменения , нажав на кнопку со стрелками.

4. Теперь можете создавать новую ветку и вносить новые изменения.

[Intuki]

Воспользовался инструкцией, вроде все получилось.
Единственное, как я понял, надо добавить в описание, что сначала нужно создать свой fork. И открывать в редакторе его, потому что прав записи в основной репозиторий https://github.com/Chimildic/goofy нет, и в п. 2 не получится создать новую ветку.

[amd64fox]

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

Другое дело если ты постоянно вносишь изменения в своё или чужое репо, но это уже другая история.