GitubSession

Внесение вклад в проекты с открытым исходным кодом с использованием git

Добро пожаловать в наш проект! Мы рады, что вы рассматриваете возможность внести свой вклад в развитие с открытым исходным кодом. Это руководство проведет вас через основные команды GIT и лучшие практики, чтобы сделать ваш вклад легким и успешным.

Оглавление

1. Подтягивание репозитория
2. Клонирование репозитория
3. Создание филиала
4. Внесение изменений
5. Совершать изменения
6. Выдвигая изменения
7. Создание запроса на притяжение
8. Синхронизировать вашу вилку
9. Советы по написанию хороших сообщений коммита

---

1. Подтягивание репозитория

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

Шаги:

1. Перейдите на страницу репозитория.
2. Нажмите кнопку «Вилка» в правом верхнем углу.
3. Теперь у вас будет копия репозитория в вашей учетной записи GitHub.

---

2. Клонирование репозитория

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

git clone https://github.com/your-username/repository-name.git

---

3. Создание филиала

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

git checkout -b feature/your-branch-name

---

4. Внесение изменений

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

---

5. совершение изменений

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

1. Добавьте изменения в зону постановки:

git add .

2. Сделайте изменения с помощью четкого и описательного сообщения:

git commit -m " Your descriptive message here "

3. Убедитесь, что ваше сообщение о коммите четко объясняет изменения, которые вы внесли.

6. Нажатие изменений

После совершения ваших изменений локально вытолкните ветвь в репозиторий GitHub.

git push origin feature/your-branch-name

Это загрузит вашу ветвь в ваш раздвоенный репозиторий на GitHub.

7. Создание запроса на притяжение

С вашими изменениями, выдвинутыми на GitHub, вы готовы отправить запрос на тягу (PR), чтобы сопровождающие могли просмотреть вашу работу.

• Перейдите к своему раздвоенному хранилищу на GitHub.
  
• Нажмите кнопку «Сравнить и протянуть запрос».
  
• Предоставьте заголовок и подробное описание ваших изменений.
  
• Отправьте запрос на вытяжение.
  
• После рассмотрения сопровождающие либо объединят ваш PR, либо предоставит обратную связь для пересмотров.
  

8. синхронизировать вашу вилку

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

1. Соберите репозиторий вверх по течению в качестве пульта:

git remote add upstream https://github.com/original-owner/repository-name.git

2. Принесите последние изменения из репозитория вверх по течению:

git fetch upstream

3. Объединить вверх по течению изменений в локальную основную ветвь:

git checkout main
git merge upstream/main

4. Нажмите обновленную главную ветвь в свою вилку:

git push origin main

9. Советы по написанию хороших сообщений коммита

• Сохраняйте это кратким: стремиться к посланию коммита, которое составляет менее 50 символов.
  
• Используйте императивное настроение: например, напишите «исправить ошибку» вместо «Исправлена ​​ошибка».
  
• Предоставьте контекст: включите номер вопроса или опишите цель изменения.
  Пример: исправить № 42 - Установить ошибку в аутентификации пользователя.