Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 7.02 KB

CONTRIBUTING.md

File metadata and controls

63 lines (51 loc) · 7.02 KB

Guia de Contribuição

Star Forks GitHub Issues

Este é um projeto feito para a comunidade, então sinta-se livre para contribuir. Algumas formas de contribuição além do seu exemplo de Profile README, é inserir outros utilitários na pasta utils, ou melhorar a página de pesquisa dos READMEs fazendo modificações nos arquivos da pasta docs.
Além disso, você também pode contribuir:

⚠️ Resolvendo, respondendo ou indicando issues

⭐ Adicionando aos favoritos (star)

Contribuindo no diretório "Community"

A contribuição no diretório "Community" faz parte do Desafio do lab Contribuindo em um Projeto Open Source no GitHub da Digital Innovation One. Você pode colaborar criando um Profile README contendo informações sobre você que deseje compartilhar com a comunidade. Para isso, você pode inserir: badges indicando suas habilidades; cards com suas estatísticas no GitHub e projetos que criou, colaborou ou que deseje que outras pessoas colaborem. Além disso, você pode inserir também links para seus desafios de projeto e artigos na plataforma da Digital Innovation One.
Inspire-se consultando os exemplos na pasta community, confira alguns utilitários na pasta utils e use sua criatividade para criar o seu 😊💙.

Instruções

  1. Faça um Fork deste repositório;

  2. Clone localmente: git clone https://github.com/SEU_USERNAME/dio-lab-open-source.git;

  3. Adicione o remote upstream para manter seu repositório local atualizado: git remote add upstream https://github.com/digitalinnovationone/dio-lab-open-source.git;

    Utilize o comando git pull upstream main para baixar e mesclar as alterações no seu repositório local com base na branch main deste repositório original de onde você fez o fork, ou git fetch upstream main para baixar sem mesclar. Veja mais em: Primeiros Passos com Git e GitHub.

  4. Crie uma nova branch e nomeie como feat/community/SEU_USERNAME:

    Exemplo: git checkout -b feat/community/digitalinnovationone

  5. Dentro da pasta community, crie um arquivo em Markdown (extensão .md) e nomeie com o mesmo nome do seu usuário no GitHub;

    Exemplo: community/digitalinnovationone.md

  6. Desenvolva o seu perfil. Para isso, você pode ver exemplos na pasta community e adicionar alguns dos utilitários presentes na pasta utils;

    Observação: Use os outros exemplos como inspiração e não cópia.

  7. Adicione suas alterações à "staging area" com o comando git add community/SEU_USERNAME.md;

    Observação: Você pode utilizar o comando git add . para adicionar todas as alterações de uma vez só.

  8. Crie um commit e adicione a mensagem indicando a adição do seu perfil git commit -m"feat: add SEU_USERNAME profile";

    Observação: Verificar a Convenção de Commits para escrever a mensagem do seu commit de forma clara e padronizada.

  9. Envie as alterações para o seu repositório remoto git push origin feat/community/SEU_USERNAME;

    Observação: Você pode utilizar o comando git push origin para mandar as alterações sem precisar especificar a URL, desde que você tenha feito o passo 3.

  10. Crie um Pull Request.

    Observação: No geral, quando você der um push para o seu repositório do Github, ele perguntará para você se deseja fazer um Pull Request. Caso não apareça, é só você ir para o repositório da DIO, clicar em Pull Request e Create, e por último indicar o seu repositório e a branch em específico

    Se tudo estiver certo, irá aparecer um template, que contém botões de múltipla escolha referente ao seu tipo de alteração, checklist e também comentários adicionais se você achar que seja bom acrescentar. Assim, quando você concluir, é somente você apertar o "Create Pull Request" que fica abaixo dessa caixa de texto e esperar a resposta do bot do Github Actions dizendo se seu PR (Pull Request) foi aceito ou não. Em caso de aprovação o bot irá disponibilidar o link do repositório com a opção de copiar, volte na plataforma da DIO e entregue seu projeto.

Convenção de Commits

Tipo de Commit Descrição Exemplo
feat Adiciona uma nova funcionalidade ao projeto. feat: add USENAME.md profile
fix Corrige um bug ou problema no projeto. fix: fixed issue fix#IssueNumber
docs Altera a documentação do projeto. Ex.: README, comentários no código. doc: altered section SECTIONNAME
style Realiza mudanças na aparência, sem alterar a funcionalidade. style: add EFFECTNAME to COMPONENT
refactor Realiza mudanças no código que não alteram a funcionalidade. refactor: refactor at CLASSNAME
test Adiciona ou modifica testes no projeto. test: testing FUNCIONALITYNAME

Desafios Git e GitHub

Referências