Skip to content

Latest commit

 

History

History
59 lines (48 loc) · 5.83 KB

CONTRIBUTING.md

File metadata and controls

59 lines (48 loc) · 5.83 KB
Raw

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/elidianaandrade/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/elidianaandrade

  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/elidianaandrade.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.

Convenção de Commits

Tipo de Commit Descrição
feat Adiciona uma nova funcionalidade ao projeto.
fix Corrige um bug ou problema no projeto.
docs Altera a documentação do projeto. Ex.: README, comentários no código.
style Realiza mudanças na aparência, sem alterar a funcionalidade.
refactor Realiza mudanças no código que não alteram a funcionalidade.
test Adiciona ou modifica testes no projeto.

Desafios Git e GitHub

Referências