Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Dicas para manutenção de projetos open source

Isabel Costa
October 24, 2020
120

Dicas para manutenção de projetos open source

Contribuir para Open Source pode ser feito de várias formas. Uma delas é quando mantemos um projetos que outros podem contribuir para. No entanto, este tipo de contribuição vem com responsabilidades adicionais. Nesta apresentação quero partilhar dicas de como manter um projeto Open Source com base no que fui aprendendo da minha experiência. Estas dicas servirão para ajudar a atrair colaboradores e criar comunidade a volta do projeto.

Isabel Costa

October 24, 2020
Tweet

Transcript

  1. Dicas para manutenção de projetos Open Source Isabel Costa |

    isabelcosta.github.io Interruptor x Hacktoberfest 24 Outubro, 2020 @isabelcmdcosta
  2. Como me tornei maintainer 1. Comecei como colaboradora Open Source

    2. Candidatei para participar no Google Summer of Code (GSoC) 3. Fui aceite para trabalhar com a comunidade AnitaB.org Open Source 4. No final do GSoC comecei oficialmente a manutenção @isabelcmdcosta
  3. Base • Licença (LICENSE.md) ◦ https://choosealicense.com/ • Código de conduta

    (CODE_OF_CONDUCT.md) ◦ https://www.contributor-covenant.org/ • README.md • Guia de contribuição (CONTRIBUTING.md) • Modelos de Issue e Pull request • Descrição e Tópicos @isabelcmdcosta
  4. Responsabilidades • Definir a direção do projeto (ex: roadmap) •

    Gerir issues e colaboradores • Rever e validar as contribuições • Ser transparente com a comunidade • Definir e reforçar o respeito do código de conduta • Definir processos e expectativas @isabelcmdcosta
  5. PR checks & Automação Pull Requests checks para: • análise

    de código (ex: vulnerabilidades, estilo de código, etc...) • build • testes • estado de deploy • … Exemplos de ferramentas: • GitHub Actions, Codecov, Codacy, CircleCI, TravisCI, … Muitas ferramentas de automação têm uma versão gratuita para projecto open source! @isabelcmdcosta
  6. Desenvolver comunidade • Promover diferentes tipos de contribuições ◦ documentação,

    código, garantia de qualidade, revisão de código, design, feedback... • Promover o projeto ◦ Participa em iniciativas Open Source ◦ Escreve posts, fala em meetups e partilha nas redes sociais • Bot de reconhecimento de contribuições ◦ all-contributors/all-contributors @isabelcmdcosta
  7. Optimizar para novos colaboradores • Boa documentação • Entende os

    novos e os atuais colaboradores • Tem um número mínimo de issues para novos colaboradores ◦ categorias: “good first issue” e “first timers only” • Ambiente de desenvolvimento fácil @isabelcmdcosta
  8. Links relevantes • Best Practices for Maintainers ⇒ https://opensource.guide/best-practices/ •

    Contribuir para Open Source como colaboradora e maintainer ◦ @ DevFest Portugal 2020 (minuto: 1h52) ⇒ https://youtu.be/-EFVDjDdeXw?t=6766 • Promoção de projeto open source (GitHub repositório) ⇒ zenika-open-source/promote-open-source-project (c/ tradução) • How to Contribute to and Maintain Open Source Projects w/ GitHub ◦ https://www.youtube.com/watch?v=vSdSFxIKy5w @isabelcmdcosta