Aumenta la tua reputazione su GitHub con messaggi di commit adeguati

Invece di scrivere messaggi git commit di una riga con l'estensione commit -m opzione, in questo articolo scopri come scrivere messaggi di commit appropriati. Un messaggio di commit corretto è importante, poiché consente agli altri di vedere esattamente cosa hai modificato, rendere il tuo progetto più facile da seguire per gli altri contribuendo ad aumentare la tua esposizione all'open source Comunità.

Scrivi un messaggio di commit corretto

Invece di includere il messaggio di commit nel comando del terminale, apri il tuo preferito editor di testo in un file vuoto. Il messaggio deve essere conforme al seguente formato:

• La prima riga è il titolo, che riassume l'intero commit.
instagram viewer
• Dopo una riga vuota, la riga successiva o più righe dovrebbe essere una qualsiasi descrizione leggibile necessaria per il commit. Questo può essere lungo quanto desiderato.
• Tutte le righe seguenti dovrebbero riepilogare le esatte modifiche apportate al codice in tale formato:
  • Filename: Line # - Breve descrizione della modifica.

Messaggio di commit di esempio

Di seguito viene mostrato un messaggio di commit di esempio:

Aggiunto supporto Docker, nuova funzione is_unique e correzione di bug.
Aggiunto supporto per docker-compose e istruzioni di installazione aggiornate secondo necessità. Includeva anche una nuova funzionalità all'interno della funzione check_order () per verificare l'unicità e risolto un piccolo bug durante la creazione di slug di prodotto.
src / somedir / library.py: 381 - Aggiunto il parametro 'is_unique' alla funzione check_order ().
src / products.py: 194 - Risolto bug durante la creazione di slug del prodotto.
docker-compose.yml - Aggiunto il file docker-compose.
docs / install.md - Guida all'installazione aggiornata per includere come installare tramite Docker.

Messaggio di commit

Quando si effettua un commit ora, invece di utilizzare il file -m messaggio, usa il--file opzione. Ad esempio, se il nome del file del messaggio di commit è commit.txt, dovresti eseguire il comando:

git commit --file commit.txt

È tutto quello che c'è da fare! Si spera che questo ti aiuti a fornire messaggi di impegno più standardizzati e chiari ai tuoi follower, aiutando il tuo progetto a ottenere visibilità e aiutare il open source la comunità cresce.

Credito immagine: Caleb White /Unsplash