Documentar como se contribui com este repositório

[villares]

Como contribuir com este material didático

Work in progress!!! https://github.com/villares/material-aulas/blob/master/como-contribuir.md

Passo 0

Crie uma conta no GitHub

Issues

Issues são a forma de registrar problemas e desejos de aprimoramento para um projeto. Criar uma issue pode ser já uma boa contribuição para um projeto.

Para criar uma issue:

• leia com cuidado o material para identificar lacunas ou problemas;
• veja se não tem uma issue parecida já (você pode comentar nela algum detalhe);
• clique no botão verde New issue.

Maneiras de usar o GitHub

• Interface web <- comece por aqui
• GitHub Desktop
• no terminal

Para propor correções ou acrescentar novos materiais

• fazer um fork (que é um repositório com o material na sua conta do GitHub)

• criar um branch (com um nome sintético da contribuição)

• como modificar arquivos

• como subir arquivos (em geral)

• como criar um arquivo Markdown (.md)

  • como se escreve markdown ou GFM?
    • guias de markdown em português (links para referências externas!)
    • como fazer links externos [__](__)
    • como formata código no markdown:
      • bloco com ```python ___``` ou no meio da frase ``
    • como inserir imagens no markdown ![__](__)
    • como subir arquivo de imagem (.png preferencialmente)

• como fazer um Pull Request (PR)

  • o que é um PR, pra quê serve, como funciona?
  • Como é a conversa com a pessoa mantenedora? Ela pode te pedir modificações/correções!
  • Importante: Não dê CLOSE quando terminar de fazer as modificações pedidas!!!
  • Como não se frustrar: como calibrar as suas expectativas.

• Como atualizar o seu fork em relação ao repositório de origem?

Work in progress!!! https://github.com/villares/material-aulas/blob/master/como-contribuir.md