Vai al contenuto

Primo contributo alla documentazione di Rocky Linux tramite CLI

Introduzione

Questa Gemma spiega come contribuire al progetto di documentazione Rocky Linux utilizzando solo l'interfaccia a riga di comando (CLI). Copre la creazione di un fork del repository la prima volta e la creazione di una richiesta di pull. Nel nostro esempio utilizzeremo la creazione di un nuovo documento Gemstone.

Descrizione del problema

I collaboratori possono preferire o avere bisogno di eseguire tutte le azioni tramite la CLI, dal fork dei repository all'invio di richieste di pull per la prima volta.

Prerequisiti

  • Un account Github
  • git e GitHub CLI (gh) installati sul proprio sistema
  • Un file markdown pronto per la pubblicazione

Passi della soluzione

  1. Fork del repository usando GitHub CLI: Fare il fork del repository upstream sul proprio account.
gh repo fork https://github.com/rocky-linux/documentation --clone
  1. Andare alla directory del repository:
cd documentation
  1. Aggiungere il repository Upstream:
git remote add upstream https://github.com/rocky-linux/documentation.git
  1. Creare un Nuovo Ramo: Creare un nuovo ramo per il proprio contributo. Digitare:
git checkout -b new-gemstone

  1. Aggiungere il nuovo documento: Utilizzate il vostro editor di testo preferito per creare e modificare il vostro nuovo file di contributo. Per questo esempio, creeremo un nuovo file chiamato gemstome_new_pr.md e lo salveremo nella cartella docs/gemstones/.

  2. Effettuare il commit delle modifiche: Eseguire il commit del nuovo file. Digitare:

git add docs/gemstones/gemstome_new_pr.md
git commit -m "Add new Gemstone document"
  1. Spingere nel proprio fork: Inviare le modifiche al proprio fork/copia del repo della documentazione di Rocky Linux. Digitare:
git push origin new-gemstone
  1. Creare una richiesta di pull: Creare una richiesta di pull al repository upstream.
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"

Informazioni aggiuntive (facoltative)

  • Usare gh pr list e gh pr status per monitorare lo stato delle richieste di pull.
  • Esaminare e seguire le linee guida per il contributo del progetto della documentazione di Rocky Linux.

Conclusione

Seguendo questi passaggi, dovreste essere in grado di creare con successo il vostro primo PR e contribuire al repository della documentazione di Rocky Linux interamente tramite la CLI!

Author: Wale Soyinka