Contribuindo em um Projeto Open Source no GitHub
Repositório desenvolvido para fins didáticos, com a disponibilização de materiais de apoio para o lab Contribuindo em um Projeto Open Source no GitHub da Digital Innovation One.
Objetivo 🎯
Aprender o básico sobre contribuição no GitHub.
Ferramentas 🛠️
Percurso
Nº | Etapas | Materiais de Apoio |
---|---|---|
01 | Introdução ao Lab | |
02 | Formas de Contribuir num Projeto Open Source | |
03 | Desenvolvendo e Enviando uma Contribuição | |
04 | Dicas e Materiais de Apoio |
Desafio: Profile README
Contribua no diretório "Community", 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 (PT/BR)
- Faça um Fork deste repositório;
- Clone localmente:
git clone https://github.com/SEU_USERNAME/dio-lab-open-source.git
; - Adicione o remote upstream para manter seu repositório local atualizado. Por exemplo:
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 branchmain
deste repositório original de onde você fez o fork, ougit fetch upstream main
para baixar sem mesclar. Veja mais em: Primeiros Passos com Git e GitHub. - Crie/Referêncie uma nova branch e nomeie como
feat/community/SEU_USERNAME
:git checkout -b feat/community/SEU_USERNAME
;Exemplo:
git checkout -b feat/community/elidianaandrade
- 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:
elidianaandrade.md
- Desenvolva o seu perfil. Para isso, você pode ver exemplos na pasta
community
e adicionar alguns dos utilitários presentes na pastautils
;Observação: Use os outros exemplos como inspiração e não cópia.
- Adicione suas alterações a "staging area" com o comando
git add community/SEU_USERNAME.md
; - Crie um commit e adicione a mensagem indicando a adição do seu perfil
git commit -m"feat: add SEU_USERNAME profile"
; - Envie as alterações para o seu repositório remoto
git push origin feat/community/SEU_USERNAME
; - Crie um Pull Request.
Instructions (EN/US)
- Fork this repository;
- Clone locally:
git clone https://github.com/YOUR_USERNAME/dio-lab-open-source.git
; - Add the upstream remote to keep your local repository updated. For instance:
git remote add upstream https://github.com/digitalinnovationone/dio-lab-open-source.git
;Use the command
git pull upstream main
to download and merge the changes in your local repository based on themain
branch of this original repository from which you forked, orgit fetch upstream main
to download without merging. Learn more at: Getting Started with Git and GitHub. - Create/Reference a new branch and name it
feat/community/YOUR_USERNAME
:git checkout -b feat/community/YOUR_USERNAME
;Example:
git checkout -b feat/community/elidianaandrade
- Inside the
community
folder, create a Markdown file (extension.md
) and name it after your GitHub username;Example:
elidianaandrade.md
- Develop your profile: For that, you can see examples in the
community
folder and add some of the utilities available in theutils
folder;Note: Use the other examples as inspiration, not as a copy.
- Add your changes to the "staging area" with the command
git add community/YOUR_USERNAME.md
; - Create a commit and add a message indicating the addition of your profile
git commit -m"feat: add YOUR_USERNAME profile"
; - Push the changes to your remote repository
git push origin feat/community/YOUR_USERNAME
; - Create a Pull Request.
Instrucciones (ES/ES)
- Haz un Fork de este repositorio;
- Clona localmente:
git clone https://github.com/TU_USERNAME/dio-lab-open-source.git
; - Añade el remote upstream para mantener tu repositorio local actualizado. Por ejemplo:
git remote add upstream https://github.com/digitalinnovationone/dio-lab-open-source.git
;Usa el comando
git pull upstream main
para descargar y fusionar los cambios en tu repositorio local basado en la ramamain
de este repositorio original del cual hiciste el fork, ogit fetch upstream main
para descargar sin fusionar. Aprende más en: Primeros Pasos con Git y GitHub. - Crea/Referencia una nueva branch y nómbrala
feat/community/TU_USERNAME
:git checkout -b feat/community/TU_USERNAME
;Ejemplo:
git checkout -b feat/community/elidianaandrade
- Dentro de la carpeta
community
, crea un archivo en Markdown (extensión.md
) y nómbralo con el mismo nombre de tu usuario en GitHub;Ejemplo:
elidianaandrade.md
- Desarrolla tu perfil. Para eso, puedes ver ejemplos en la carpeta
community
y añadir algunas de las utilidades presentes en la carpetautils
;Nota: Usa los otros ejemplos como inspiración y no como copia.
- Agrega tus cambios al "área de preparación" con el comando
git add community/TU_USERNAME.md
; - Crea un commit y añade un mensaje indicando la adición de tu perfil
git commit -m"feat: add TU_USERNAME profile"
; - Envía los cambios a tu repositorio remoto
git push origin feat/community/TU_USERNAME
; - Crea un Pull Request.
Utilitários
Contribua
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:
⭐ Adicionando aos favoritos (star)