git-commit/index.html at main · Katumbela/git-commit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<!DOCTYPE html>
<html lang="pt-br">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Git Commit CLI</title>
    <style>
        body {
            font-family: Arial, sans-serif;
            line-height: 1.6;
            margin: 0;
            padding: 20px;
            background-color: #f4f4f4;
        }
        h1, h2, h3 {
            color: #333;
        }
        code {
            background: #eee;
            border-radius: 3px;
            padding: 2px 4px;
            font-size: 90%;
        }
        pre {
            background: #eee;
            border-radius: 3px;
            padding: 10px;
            overflow-x: auto;
        }
        a {
            color: #1e90ff;
            text-decoration: none;
        }
        a:hover {
            text-decoration: underline;
        }
    </style>
</head>
<body>

    <h1>Git Commit CLI</h1>

    <p>Uma ferramenta CLI para adicionar e commitar arquivos não rastreados e modificados em um repositório Git.</p>

    <h2>Instalação</h2>

    <p>Para instalar o pacote globalmente e usá-lo em qualquer projeto, execute:</p>

    <pre><code>npm install -g git-commit-lib</code></pre>

    <p>Ou você pode instalar localmente em um projeto específico e usar com <code>npx</code>:</p>

    <pre><code>npm install git-commit-lib</code></pre>

    <h2>Uso</h2>

    <p>Depois de instalar, você pode usar o comando <code>commit-kat</code> para adicionar e commitar arquivos em seu repositório Git.</p>

    <h3>Comando Básico</h3>

    <pre><code>npx commit-kat</code></pre>

    <h3>Flags</h3>

    <ul>
        <li><code>--all</code> ou <code>-a</code>: Comita todos os arquivos não rastreados e modificados de uma vez.
            <pre><code>npx commit-kat --all</code></pre>
        </li>
        <li><code>--push</code> ou <code>-p</code>: Comita os arquivos e faz um <code>git push</code> no final.
            <pre><code>npx commit-kat --push</code></pre>
        </li>
        <li><code>--all --push</code> ou <code>-a -p</code>: Comita todos os arquivos de uma vez e faz um <code>git push</code> no final.
            <pre><code>npx commit-kat --all --push</code></pre>
        </li>
    </ul>

    <h3>Exemplos</h3>

    <ol>
        <li>Adicionar e commitar arquivos não rastreados e modificados separadamente:
            <pre><code>npx commit-kat</code></pre>
        </li>
        <li>Adicionar e commitar todos os arquivos de uma vez:
            <pre><code>npx commit-kat --all</code></pre>
        </li>
        <li>Adicionar e commitar arquivos, e fazer um push para o repositório remoto:
            <pre><code>npx commit-kat --push</code></pre>
        </li>
        <li>Adicionar e commitar todos os arquivos de uma vez e fazer um push:
            <pre><code>npx commit-kat --all --push</code></pre>
        </li>
    </ol>

    <h2>Conventional Commits</h2>

    <p>O <code>commit-kat</code> segue a <a href="https://www.conventionalcommits.org/" target="_blank">Conventional Commits</a> para criar mensagens de commit mais informativas e padronizadas:</p>

    <ul>
        <li><code>feat:</code> Para novos recursos ou adições.</li>
        <li><code>fix:</code> Para correções de bugs.</li>
        <li><code>chore:</code> Para tarefas e manutenção do projeto (como exclusões de arquivos).</li>
    </ul>

    <h3>Exemplo de Mensagens de Commit</h3>

    <ul>
        <li>Para arquivos não rastreados (adicionados):
            <pre><code>git commit -m "feat: commit 1 - arquivo_exemplo.js"</code></pre>
        </li>
        <li>Para arquivos modificados:
            <pre><code>git commit -m "fix: commit 2 - arquivo_modificado.js"</code></pre>
        </li>
        <li>Para arquivos excluídos:
            <pre><code>git commit -m "chore: commit 3 - arquivo_excluido.js"</code></pre>
        </li>
    </ul>

    <h2>Autor</h2>

    <p>João Afonso Katombela<br>
    <a href="https://www.linkedin.com/in/joao-afonso-katumbela" target="_blank">LinkedIn</a><br>
    <a href="https://github.com/katumbela" target="_blank">GitHub</a></p>

    <h2>Contribuindo</h2>

    <p>Contribuições são bem-vindas! Sinta-se à vontade para enviar pull requests ou relatar problemas.</p>

    <h2>Licença</h2>

    <p>Este projeto está licenciado sob a MIT License - veja o arquivo <a href="LICENSE">LICENSE</a> para detalhes.</p>

</body>
</html>