Skip to content

Latest commit

 

History

History
162 lines (136 loc) · 12.3 KB

README.md

File metadata and controls

162 lines (136 loc) · 12.3 KB
Raw

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.

Link do Lab Link do Lab

Objetivo 🎯

Aprender o básico sobre contribuição no git e GitHub.

Ferramentas 🛠️

GitHub Git

Percurso

Nº Etapas Materiais de Apoio
01 Introdução ao Lab Material de Apoio
02 Formas de Contribuir num Projeto Open Source Material de Apoio
03 Desenvolvendo e Enviando uma Contribuição Material de Apoio
04 Dicas e Materiais de Apoio Material 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)

  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. 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 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/Referêncie uma nova branch e nomeie como feat/community/SEU_USERNAME:

    Exemplo: git checkout -b feat/community/Cristian0-Pereira

  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: rafaeldscordeiro.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 a "staging area" com o comando git add community/SEU_USERNAME.md;
  8. Crie um commit e adicione a mensagem indicando a adição do seu perfil git commit -m"feat: add SEU_USERNAME profile";
  9. Envie as alterações para o seu repositório remoto git push origin feat/community/SEU_USERNAME;
  10. Crie um Pull Request.

Como atualizar seu perfil do Github usando seu arquivo README

Agora que você já criou seu README.md, é possível compartilhar essas informações com toda comunidade do Github.com dentro do seu perfil de usuário. Basta seguir o guia: Gerenciar o README do seu perfil, disponibilizado pela própria plataforma.

Instructions (EN/US)

  1. Fork this repository;
  2. Clone locally: git clone https://github.com/YOUR_USERNAME/dio-lab-open-source.git;
  3. 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 the main branch of this original repository from which you forked, or git fetch upstream main to download without merging. Learn more at: Getting Started with Git and GitHub.

  4. 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/rafaeldscordeiro

  5. Inside the community folder, create a Markdown file (extension .md) and name it after your GitHub username;

    Example: rafaeldscordeiro.md

  6. Develop your profile: For that, you can see examples in the community folder and add some of the utilities available in the utils folder;

    Note: Use the other examples as inspiration, not as a copy.

  7. Add your changes to the "staging area" with the command git add community/YOUR_USERNAME.md;
  8. Create a commit and add a message indicating the addition of your profile git commit -m"feat: add YOUR_USERNAME profile";
  9. Push the changes to your remote repository git push origin feat/community/YOUR_USERNAME;
  10. Create a Pull Request.

How update your Github profile using your README file

Now that you have created your README.md, you can share this information with the entire Github.com community within your user profile. Just follow the guide: Managing your profile README, provided by the platform itself.

Instrucciones (ES/ES)

  1. Haz un Fork de este repositorio;
  2. Clona localmente: git clone https://github.com/TU_USERNAME/dio-lab-open-source.git;
  3. 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 rama main de este repositorio original del cual hiciste el fork, o git fetch upstream main para descargar sin fusionar. Aprende más en: Primeros Pasos con Git y GitHub.

  4. 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/rafaeldscordeiro

  5. 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: rafaeldscordeiro.md

  6. Desarrolla tu perfil. Para eso, puedes ver ejemplos en la carpeta community y añadir algunas de las utilidades presentes en la carpeta utils;

    Nota: Usa los otros ejemplos como inspiración y no como copia.

  7. Agrega tus cambios al "área de preparación" con el comando git add community/TU_USERNAME.md;
  8. Crea un commit y añade un mensaje indicando la adición de tu perfil git commit -m"feat: add TU_USERNAME profile";
  9. Envía los cambios a tu repositorio remoto git push origin feat/community/TU_USERNAME;
  10. Crea un Pull Request.

Cómo actualizar su perfil de Github usando su archivo README

Ahora que ha creado su README.md, puede compartir esta información con toda la comunidad Github.com dentro de su perfil de usuario. Simplemente sigue la guía: Administrar el README de tu perfil, proporcionada por la propia plataforma.

Utilitários

Badges Card Stats Badges

Contribua

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)

Membros da comunidade que já contribuiram:

Feito com 💙 por Eli.