-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathboas-praticas.html
138 lines (135 loc) · 8.44 KB
/
boas-praticas.html
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
134
135
136
137
138
<!DOCTYPE html>
<html lang="pt-BR">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Fábio César" />
<meta name="description"
content="Essa página contém informações sobre como decidimos nos organizar como equipe para estruturar o trabalho pelo Github." />
<title>Guia Git e Github - Boas Práticas</title>
<link rel="stylesheet" href="./css/style.css">
</head>
<body>
<nav style="border: 2px solid black; padding: 0px">
<table>
<tr>
<td><a href="https://github.com/diegocoliveira/equipe10-dev-html" target="_blank"><img
src="./imagens/github.svg"
alt="logotipo Github, um círculo preto com a silhueta de um gato no centro"
style="height:30px;" /> </a></td>
<td>| <a href="./index.html">Página Inicial</a> | </td>
<td><a href="./command.html">Comandos Básicos</a> | </td>
<td><strong><a href="./boas-praticas.html">Requisitos e boas Práticas na Comunicação</a></strong> |
</td>
<td><a href="./equipe.html">Equipe</a></td>
</tr>
</table>
</nav>
<!-- Cabeçalho de título e um parágrafo introdutório -->
<header style="text-align:center">
<h2>Requisitos e Boas Práticas na Comunicação</h2>
</header>
<!-- Seção do artigo da página, contendo um conteúdo e um menu de navegação para esse conteúdo -->
<article>
<nav style="border: 2px solid black; padding: 2px">
<header style="text-align:center;">
<strong>Menu de Navegação</strong>
</header>
<ul>
<li><a href="#intro">Introdução</a></li>
<li><a href="#naming">Nomenclatura</a></li>
<li><a href="#command">Comandos</a></li>
<li><a href="#pull">Pull Requests</a></li>
<li><a href="#description">Descrição do Repositório</a></li>
<li><a href="#coc">Código de Conduta</a></li>
<li><a href="#ref">Referências</a></li>
</ul>
</nav>
<section id="intro">
<h3>Introdução</h3>
<p>Uma comunicação efetiva busca sempre ser clara e concisa, ou seja, permite que toda a informação seja transmitida e que não aconteça de forma confusa. A fim de atingir esse objetivo, nosso grupo adotou algumas práticas para nomenclatura de branches e commits, bem como padronizou a forma como será realizada "pull requests" e "merge commits" no nosso repositório remoto de acordo com as regras do exercício do tira-dúvidas.</p>
</section>
<section id="naming">
<h3>Nomenclatura</h3>
<p>Todas as nomenclaturas devem utilizar o <a href="https://www.theserverside.com/definition/Kebab-case" target="_blank">kebab-case</a>, escrevendo em letras minúsculas e com separações indicadas por hífen.</p>
<p>Branches</p>
<p>Acordado pelo grupo de conter a estrutura "primeiro-nome-do-criador/conteúdo".</p>
<p>Commits</p>
<p>Acordado pelo grupo de seguir o padrão definido pelo <a href="https://github.com/stone-payments/stoneco-best-practices/blob/master/gitStyleGuide/README.md" target="_blank">guia de estilo Git</a> do repositório <a href="https://github.com/stone-payments/stoneco-best-practices" target="_blank">"stoneco-best-practices"</a>.</p>
</section>
<section>
<h3 id="command">Regras</h3>
<p>Para o projeto estamos seguindo todas as regras exigidas como requisitos de acordo como especificados
em
<a href="https://alluring-beluga-3dd.notion.site/Projeto-site-HTML-git-Turing-f5636a96cbf9445fb53f810d88831fbf"
target="_blank">regras do projeto</a> e adotamos alguns pontos em consenso com a equipe. Dentre
todas regras destacamos as seguintes:
</p>
<ul>
<li>é proíbido realizar commits e push na branch main;</li>
<li>deve-se abrir uma Pull Request sempre que for integrar algum trabalho na branch main; </li>
<li>somente após todos os colaboradores revisarem a Pull Request que pode ser realizado o merge na
origin/main;</li>
<li><em>todos os commits devem estar verificados/assinados (preferencialmente com chaves GPG) para
que uma Pull Request seja aprovada;</em></li>
<li>após concluir uma Pull Request deve-se apagar a topic branch;</li>
<li><em>em caso de conflitos durante o merge deve-se colocar a Pull Request em draft, realizar
rebase e resolver localmente;</em></li>
</ul>
</section>
<section>
<h3 id="pull">Pull Requests</h3>
<p>Ao abrir uma Pull Request deve ser as seguintes etapas:</p>
<ol>
<li>ir para branch <strong>main</strong>, realizar fetch e merge com a <strong>origin/main</strong>; </li>
<li>retornar a sua <strong>topic branch</strong> e realizar <strong>rebase main</strong>;</li>
*obs. resolver os conflitos caso exista.
<li>realizar o commit assinado;</li>
<li>fazer push com repositório remoto; </li>
<span style="color:red;">será que o push obrigatoriamente será forçado?</span>
<li>abrir a Pull Request;</li>
*obs. lembrar de marcar-se com autor e solicitar que os demais colaboradores sejam revisores.
<li>todos os revisores devem aprovar ou solicitar explicitamente quais correções devem ser feitas;</li>
<li>somente após todos as correções terem sido realizadas e todos os revisores terem aprovado que
pode realizar o merge na main</li>
<strong>*obs. caso na hora de realizar o merge o gitHub acusar algum conflito a pull request deve ir
para o estado de draft e retomar para o passo 1.</strong>
</ol>
</section>
<section id="description">
<h3>Descrição do Repositório</h3>
<p>Repositórios devem possuir uma descrição símples do seu objetivo. No caso do nosso repositório, essa descrição está localizada no arquivo README.md em sua pasta raiz.</p>
</section>
<section id="coc">
<h3>Código de Conduta</h3>
<p>Todos os membros do grupo se comprometeram a seguir alguns valores em relação à forma como será realizado o trabalho e a comunicação durante a tarefa:</p>
<ul>
<li>sendo receptivo</li>
<li>sendo participativo</li>
<li>sendo respeitoso</li>
<li>sendo colaborativo</li>
<li>sendo comunicativo e pedindo ajuda</li>
</ul>
<p>Todos os membros do grupo condenam qualquer tipo de ato que incite discriminação, violência, segregação ou que possa causar constrangimento devido a comentários negativos direcionados a uma ou mais pessoas envolvidas ou não no projeto.</p>
</section>
<section id="ref">
<h3>Referências</h3>
<p>Referências para a construção dessa página:</p>
<ul>
<li><a href="https://alluring-beluga-3dd.notion.site/Projeto-site-HTML-git-Turing-f5636a96cbf9445fb53f810d88831fbf"
target="_blank">https://alluring-beluga-3dd.notion.site/Projeto-site-HTML-git-Turing-f5636a96cbf9445fb53f810d88831fbf</a>
</li>
<li><a href="https://www.theserverside.com/definition/Kebab-case"
target="_blank">https://www.theserverside.com/definition/Kebab-case</a></li>
<li><a href="https://github.com/stone-payments/stoneco-best-practices"
target="_blank">https://github.com/stone-payments/stoneco-best-practices</a></li>
</ul>
</article>
</section>
<!--Rodapé-->
<footer>
Eu sou <strong>Janaína Scher</strong> e modifiquei essa página no dia <strong>12/05/2022 22:59</strong>. Caso você tenha modificado essa página atualize com seu nome,data e hora. <br/>
<strong>Obs. Em caso de conflito sempre opte pela a modificação mais recente.</strong>
</footer>
</body>
</html>