Github II - Projetos

Bombásticos
 ● Boas práticas - Branches e
Commits
O que vamos
● README de projetos
ver hoje?
● Dicas de repositórios
Boas Práticas - Branches e
Commits
Branches - Boas Práticas
Master : Código em produção, que
será usado diretamente pelos
clientes.

Develop: Próximo código que irá para

produção . Deve-se deixar estável.

Feature/new-post : Recebe o nome

feature/descrição-funcionalidade.

Topic/post-content : Recebe o nome

topic/descrição-funcionalidade, usada
para fácil revisão e leitura de código.

Para saber mais

Commits - Boas Práticas
1. Commit em Códigos completos e testados

Divida suas tarefas de desenvolvimento em menores tarefas, a cada mini tarefa

terminada e testada commit o seu código.

2. Faça pequenos Commits

Commitar com mais frequência é uma excelente prática. Por exemplo, a cada bug
resolvido commite aquele trecho de código.

3. Descreva Claramente os seus Commits

Faça uma descrição clara e direta do que foi feito naquele commit, facilitando
assim a navegação entre commits, caso necessário.
Commits - Boas Práticas - Tipos
● Feat: para um novo recurso alterado
<tipo>[escopo opcional]:
● Fix: a resolução de um bug
<descrição>
● Style: atualizações relacionadas à
[corpo opcional]
estilização
● Refactor: refatoração de um trecho do [rodapé opcional(s)]

código
● Test: relacionado a testes
feat: adiciona uma nova
● Docs: relacionado à documentação funcionalidade no seu código.

● Chore: manutenção regular do código.

Commits - Boas Práticas para descrevê-los

✅ Exemplos de boas mensagens

Se aplicado, este commit corrigirá o erro de dados duplicados

Se aplicado, esse commit removerá o método x
Se aplicado, esse commit atualizará a documentação
Commits - Boas Práticas para descrevê-los
❌ Não Fazer ✅ Fazer
Readme de Projetos
Repositórios de projeto,
como usar melhor?
Perfil Pessoal Bombástico 💣 -
Repo Público x Repo Privado

Não precisa ter medo do seu repositório estar perfeito ou não. Nosso
Github também é uma ferramenta importante de estudos ( Lembra
das contribuições diárias ? 🟩 ) .

Com ele, você pode criar vários repositórios com os assuntos que
você tá aprendendo e gerenciar quem vai visualizar ou não.
Perfil Pessoal Bombástico 💣 -
Repo Público x Repo Privado

Repo Público

Repo Privado
Perfil Pessoal Bombástico 💣 -
Repo Público x Repo Privado

Repo Público 🔦 Repo Privado 󰡲

● Projetos que você se orgulha ● Projetos de estudo, que você

● Por um bom README
● Tecnologias e área baseado
na vaga que deseja.
● Saber exatamente o por que
ainda está mexendo
● Projetos pessoais e/ou de
negócios
● Projetos de processos
seletivos.
README de projeto,
como se destacar?
 Um bom README é composto
por:

Um bom 1.
2.
Acessibilidade
Capa
README 3.
4.
Descrição
Template
Um bom README 📖 - Acessibilidade

Sempre que for fazer um README, questione-se algumas coisas

🤔🤔:

● Uma pessoa sem nível técnico de desenvolvimento consegue ler,

rodar e visualizar o seu projeto facilmente?

● Está fácil e rápido o acesso?

Um bom README 📖 - Capa

- Ter uma capa é um

excelente modo de dar
boas vindas ao seu
usuário!

- Você pode criar de forma

rápida e gratuita usando
o Canva

- Tamanho :
1400 px (Largura) X 360px
(Altura
Um bom README 📖 - Descrição
- Título : Dar o nome de
forma sucinta e objetiva
(obrigatório)

- Descrição : Escrever de forma sucinta sobre o que é o seu projeto e qual é o intuito dele
(obrigatório)
Um bom README 📖 - Descrição

- Quem Desenvolveu o projeto : Escrever

de forma sucinta sobre o que é o
seu projeto e qual é o intuito dele.
Colocar o link do Github
(obrigatório)

- Pré-Requisitos : Colocar as
funcionalidades que você
conseguiu implementar
(obrigatório)

Link : Colocar o link do projeto,

pensando que a pessoa recrutadora
terá pouquíssimo tempo, ter o Link é
fundamental (obrigatório)
Um bom README 📖 - Descrição
- Tecnologias Usadas :
Colocar quais
tecnologias você usou
para desenvolver o
projeto (obrigatório)

- Como Rodar o Projeto :

Colocar o passo-a-passo
de como faz para rodar
o projeto (obrigatório)
Um bom README 📖 - Descrição
- Status: Mostrar o que
você fez, o que você não
fez ou está em
andamento

- Concepção do Projeto :
Explicar como o projeto
foi construído.

Alguns diagramas :
modelagem do banco
de Dados (Back-end),
protótipo no Figma |
Adobe XD ou em
aplicativos de edição
(Front-end).
Um bom README 📖 - Descrição
- Licença: Mostrar sob qual
licença o projeto foi
feito. Para saber mais é
só clicar aqui.

- Tabela de Conteúdos :
Colocar links para cada
parte do REDME..
Um bom README 📖 - Inspire-se!

● https://github.com/animavita/ani ● https://github.com/invertase/rea
mavita ct-native-firebase
● https://github.com/iterative/cml ● https://github.com/othneildrew/
● https://github.com/gatsbyjs/gats Best-README-Template
by
● https://github.com/steniowagner
/mindCast
Um bom README 📖 - Template

Agora que vocês já viram a diferença entre Git e Github e

como ter um Github bombástico, basta aproveitar esse
Template lindão que fizemos para vocês ⬇

Template Lindão Github

 Agora é com você!

1. Baseado nas dicas dadas na

aula de hoje, atualize 2 README

Praticando … de projeto dos melhores

trabalhos que você já fez até
agora no curso.
Dicas de Repos
● Perguntas de Entrevistas Front-end
● Vagas de Front-end
● Vagas de Backend
● Livros úteis de programação
● Desafios técnicos Front-end
● Mulheres na tecnologia
● Conteúdo Gratuito
● Curso para Iniciantes
● Guia Dev
● Livros de Programação
● READMEs pessoais
Dicas de Repos
● 20 repositórios legais para favoritar
● Livros gratuitos de programação
● Roadmap de programação
● Ideias de projetos para construir
● Perguntas de entrevistas técnicas
Dúvidas? 🧐
Obrigado(a)!