Перейти до змісту

Перший внесок у документацію Rocky Linux через CLI

Вступ

Цей Gemstone детально описує, як зробити внесок у проект документації Rocky Linux, використовуючи лише інтерфейс командного рядка (CLI). Він охоплює розгалуження сховища вперше та створення запиту на отримання. У нашому прикладі ми використаємо новий документ Gemstone.

Опис проблеми

Співавтори можуть віддавати перевагу або потребувати виконувати всі дії через CLI, від розгалуження репозиторіїв до подання запитів на отримання вперше.

Передумови

  • Обліковий запис GitHub
  • git і GitHub CLI (gh) встановлені у вашій системі
  • Файл markdown, готовий для внесення

Етапи рішення

  1. Розгалужте репозиторій за допомогою GitHub CLI: Розгалужте репозиторій вище за течією до свого облікового запису.
gh repo fork https://github.com/rocky-linux/documentation --clone
  1. Перейдіть до каталогу сховища:
cd documentation
  1. Додайте репозиторій Upstream:
git remote add upstream https://github.com/rocky-linux/documentation.git
  1. Створіть нову гілку: Створіть нову гілку для свого внеску. Впишіть:
git checkout -b new-gemstone

  1. Додайте свій новий документ: Використовуйте свій улюблений текстовий редактор, щоб створити та відредагувати новий файл внеску. Для цього прикладу ми створимо новий файл під назвою gemstome_new_pr.md і збережемо його в каталозі docs/gemstones/.

  2. Зафіксуйте свої зміни: Створіть і зафіксуйте новий файл. Впишіть:

git add docs/gemstones/gemstome_new_pr.md
git commit -m "Add new Gemstone document"
  1. Натисніть на свою вилку: Надішліть зміни у свій форк/копію сховища документації Rocky Linux. Впишіть:
git push origin new-gemstone
  1. Створіть запит на отримання: Створіть запит на отримання до репозиторію вище за течією.
gh pr create --base main --head wsoyinka:new-gemstone --title "New Gemstone: Creating PRs via CLI" --body "Guide on how to contribute to documentation using CLI"

Додаткова інформація (необов'язково)

  • Використовуйте gh pr list і gh pr status, щоб відстежувати статус ваших запитів на отримання.
  • Ознайомтеся з інструкціями щодо внеску проекту документації Rocky Linux і дотримуйтеся їх.

Висновок

Виконавши ці кроки, ви зможете успішно створити свій перший PR і зробити внесок у сховище документації Rocky Linux повністю через CLI!

Author: Wale Soyinka