Skip to content

Commit 8642e8c

Browse files
authored
Merge pull request #35 from geidsonc/feature/sugestao-texto-pr
Altera parágrafo sobre colaboração com branch e sugere leitura sobre modelos de desenvolvimento colaborativos.
2 parents 2c45fd3 + 4fe3a8f commit 8642e8c

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

Diff for: manuscript/colaboradoras.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Colaboradoras
22

3-
Aqui está a lista de pessoas que colaboraram com Pull Request (PR) para este livro :sparkles:.
3+
Aqui está a lista de pessoas que colaboraram com Pull Request (PR) para este livro :sparkles:.
44

55
- [Adail Horst](https://github.com/SpawW)
66
- [Vinícius Mamoré](https://github.com/vmamore)
@@ -10,6 +10,7 @@ Aqui está a lista de pessoas que colaboraram com Pull Request (PR) para este li
1010
- [Kelvin Salton](https://github.com/kelvins)
1111
- [Paulo Gonçalves](https://github.com/PauloGoncalvesBH)
1212
- [Ricardo Tássio](https://github.com/ricardotassio)
13+
- [Geidson Benício](https://github.com/geidsonc)
1314

1415
Meu muito obrigado por melhorarem o material e assim contribuirem para toda a comunidade :tada:.
1516

Diff for: manuscript/o_que_e_pr.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,25 @@ Se a funcionalidade for feita no mesmo local de código mas em linhas diferentes
3333

3434
A sugestão é que funcionalidades diferentes sejam tratadas de forma isolada, a fim de não causar conflito algum no processo.
3535

36-
Todo esse processo que descrevi aqui, pode ser feito também baseado em branch, mas a pessoa que colabora precisa ser membro do repositório e não uma pessoa aleatória na internet, pois ela precisa ter permissão para criar branch no repositório. No fim é o mesmo propósito, mas ao invés de repositório inteiro, tudo que expliquei aqui acontece no nível de ramificações.
36+
Todo esse processo que descrevi aqui, também pode ser feito em um modelo baseado em branch. Nesse modelo a pessoa que colabora precisa ser adicionada como membro do repositório, ter permissões para criar branch e ter acesso a push (empurrar mudanças). Esse é um modelo muito usado por equipes e empresas que colaboram em projetos privados.
3737

38-
Por fim, note que em outras plataformas de repositórios online, o conceito de Pull Request pode ter outros nomes como por exemplo Merge Request(Requisição para mergear).
38+
Se você quiser conhecer mais sobre esses dois modelos de desenvolvimento colaborativo, sugiro aprofundar a leitura em [Sobre modelos de desenvolvimento colaborativo](https://docs.github.com/pt/github/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)
39+
40+
Por fim, note que em outras plataformas de repositórios online, o conceito de Pull Request pode ter outros nomes como por exemplo Merge Request (requisição para mergear).
3941

4042
## Como usar Pull Request para o processo de revisão?
4143

4244
A maioria das organizações utiliza o Pull Request como mecanismo padrão para revisão de código, pois ele é basicamente a "porta de entrada" para a base "oficial" de código, seja em relação ao repositório ou branch.
4345

4446
Normalmente as branchs que serão usadas para construir o artefato final do repositório oficial são protegidas e não podem receber commits diretos, ou seja, tudo que entra nessas branchs devem entrar por um PR (Pull Request). Existe a possibilidade do administrador do repositório mandar o código direto, mas isso deve ser apenas uma exceção. Dito isso, eu reforço, **mesmo os administradores do repositório**, **pessoas desenvolvedoras experientes**, ou até mesmo a **liderança técnica** do time devem mandar suas mudanças por PR e elas devem ser avaliadas por outras pessoas.
4547

46-
Quando começar a trabalhar em uma funcionalidade nova do repositório. Eu faço parte da organização? Tenho acesso a criar uma branch? Caso positivo, eu crio uma branch.
48+
Quando começar a trabalhar em uma nova funcionalidade do repositório, verifique se você faz parte da organização e tenho acesso a criar uma branch. Caso positivo, crie uma branch.
4749

48-
Existe um Padrão para criação de branch? Eu gosto do modelo "feature/nome-da-funcionalidade" assim fica muito claro para todo mundo no que você está trabalhando. Se você usa algum sistema de ticket para gerenciar as tarefas você pode colocar o identificador do ticket também: ""feature/nome-da-funcionalidade#435".
50+
Existe um padrão para criação de branch? Eu gosto do modelo "feature/nome-da-funcionalidade" assim fica muito claro para todo mundo no que você está trabalhando. Se você usa algum sistema de ticket para gerenciar as tarefas você pode colocar o identificador do ticket também: ""feature/nome-da-funcionalidade#435".
4951

5052
![Proposta de fluxo para Pull Request](resources/images/pullrequest2.png)
5153

52-
Lembre-se que sua branch precisa ser bem específica, ou seja, se "aparecer" outra demanda, o aconselhável é abrir outra branch a partir de branch "oficial" (que normalmente é a "master").
54+
Lembre-se que sua branch precisa ser bem específica, ou seja, se "aparecer" outra demanda, o aconselhável é abrir outra branch a partir de branch "oficial" (que normalmente é a "master" ou "main").
5355

5456
Quando você tiver muita confiança que seu código entrega tudo que a funcionalidade precisa para existir, você deve abrir um PR e na descrição desse PR você deve detalhar qual comportamento esperar dessa mudança que você está propondo.
5557

@@ -98,6 +100,8 @@ A maioria das organizações seguem alguns padrões para como escrever código,
98100

99101
Esse padrão deve estar claro em algum lugar, e a pessoa que vai colaborar deve ler isso antes, mas nem sempre isso é possível e dessa forma a colaboração pode não seguir esse padrão. Você que está avaliando deve deixar bem claro para esta pessoa qual regra ela está infligindo e qual parte do código isso acontece. O github oferece a funcionalidade de comentar nas linhas do código do PR.
100102

103+
Algumas discussões sobre detalhes de padrões podem ser tratadas e revisadas automaticamente com uso de ferramentas, como um bom formatador e um linter, que ajuda a economizar muito tempo da equipe com as revisões.
104+
101105
![Comentário no review](resources/images/pullrequest4.png)
102106

103107
Depois que comentar todo o PR não esqueça de finalizar sua revisão, caso contrário a pessoa que fez o PR não verá seu comentário.

0 commit comments

Comments
 (0)