Issues, bugs e backlogs
Como gerenciar feedback em um projeto open source grande como o Flutter
O crescimento do Flutter como projeto de código aberto impulsionado pela comunidade é uma fonte constante de satisfação para nós, aqui no Google. Seja medido em popularidade no GitHub, número de projetos criados ou crescimento de habilidades, 2019 foi um ano decisivo para o projeto, e somos muito gratos a todos vocês pelo apoio e pelas contribuições que tornam o Flutter o projeto que ele é. Construímos o Flutter com vocês e para vocês, e esperamos que isso transpareça em tudo o que fazemos.
Conforme crescemos, o número de issues que precisamos acompanhar também cresce! Usamos issues no GitHub de várias formas: não apenas para relatar bugs, mas para qualquer unidade de trabalho relacionada ao projeto. Qualquer pessoa pode enviar uma issue, e essas issues se dividem em várias categorias:
Pedidos de funcionalidade: coisas que um usuário ou colaborador gostaria que o Flutter pudesse fazer, ou fizesse melhor.
-
Issues de suporte: dúvidas de usuários sobre como o Flutter funciona ou como fazer determinadas coisas. Embora seja melhor fazer essas perguntas no Stack Overflow, muitas apontam formas de melhorarmos também nossa documentação.
-
Defeitos reais: coisas que não funcionam como deveriam. Isso inclui problemas graves, como crashes e regressões de desempenho, mas também aqueles bugs chatos de acabamento que são comuns em qualquer sistema de software grande.
Itens não triados, que ainda não foram examinados nem rotulados.
Assim, nossas issues não são apenas uma coleção de defeitos; elas são nosso backlog. Tudo o que pensamos em trabalhar deve ser representado como uma issue, devidamente rotulada, para que, ao planejar nossas metas e marcos, tenhamos um ponto de partida.
Alguns projetos usam o número de bugs abertos como indicador da qualidade de uma versão e classificam bugs como defeitos ou issues. O Flutter não faz isso; optamos por rastrear bugs e issues da mesma forma, no GitHub, mantendo tudo aberto. Como resultado, sempre haverá muito mais coisas que poderiam ser feitas do que as que estamos de fato trabalhando. Isso vale para muitos projetos de código aberto saudáveis; basta olhar para outros que existem há um bom tempo, como TensorFlow, Chrome, Dart, Go ou VSCode.
Ainda assim, queremos garantir que as issues recebidas estejam bem rotuladas e que façamos o trabalho de manutenção necessário, para que nosso banco de issues reflita com precisão o status do produto. Para isso, envolvemos a comunidade: há vários voluntários nos ajudando com a triagem de primeira linha, e temos o prazer de anunciar que fizemos parceria com a Nevercode, responsável pelo Codemagic, um dos principais sistemas de CI/CD para Flutter, para nos ajudar também com a triagem de primeira linha.
O ciclo de vida de uma issue
Damos as boas-vindas a novas issues enviadas! Nosso processo de triagem de issues está descrito em Diretrizes para triagem. Veja como ele funciona na prática:
Uma issue começa com você: um usuário do Flutter ou um colaborador de código aberto. Depois que você a registra (de preferência com um caso reproduzível, se for um bug, ou um esboço claro do que você propõe e por quê, se for um pedido de funcionalidade), ela segue para a triagem de primeira linha.
Na triagem de primeira linha, um participante da comunidade (talvez um voluntário, talvez alguém da Nevercode ou um engenheiro que trabalha no Flutter) examina a issue que você registrou e faz várias perguntas:
Ela está claramente definida?
Se for um bug, ele tem um caso reproduzível e informações suficientes para trabalhar?
-
Se for uma melhoria de funcionalidade, entendemos o suficiente sobre o que você está pedindo para avaliar sua contribuição para a plataforma?
Ela duplica uma issue registrada anteriormente?
Ao fazer isso, a triagem de primeira linha aplica o maior número possível de rótulos à issue. Usamos esses rótulos de muitas maneiras, como para estabelecer a prioridade relativa, decidir como encaminhar uma issue para uma equipe específica e determinar se ela entra em um marco futuro. Usamos consultas do GitHub e algumas ferramentas personalizadas para analisar as issues em busca de sinais sobre o que a comunidade procura e por quê.
Dali, ela segue para a triagem secundária, em que uma equipe responsável analisa a issue e pergunta, por exemplo, como ela se encaixa no trabalho atual da equipe e quando é possível agendar sua conclusão. Novamente, mais rótulos podem ser adicionados ou alterados, já que eles nos dão os melhores instantâneos possíveis do trabalho que queremos fazer e de quem pode fazê-lo.
Em algum momento, um engenheiro se oferece para trabalhar na issue. Diferente de muitos projetos de software, geralmente não atribuímos issues a colaboradores: seja ou não funcionário do Google, as pessoas se oferecem para resolver issues, em vez de receber issues atribuídas do backlog. Ao deixar que as pessoas se ofereçam, distribuímos o balanceamento de carga entre os colaboradores individuais; cada colaborador se atribui apenas às issues em que está de fato trabalhando e define marcos para elas, para que saibamos quando elas chegarão à branch master. Líderes podem pedir a pessoas específicas que trabalhem em issues, claro, mas na maioria das vezes é isso: um pedido de ajuda, não um ultimato ou uma atribuição.
Quando uma issue é concluída de forma satisfatória, ela é fechada. Muitas vezes isso inclui um link para o pull request que resolve a issue, mas há outros motivos para fecharmos issues, incluindo:
-
Trata-se de um pedido de suporte? Direcionamos quem reportou para um canal de suporte, como a lista de discussão flutter-dev@googlegroups.com (lista de e-mails), o r/FlutterDev no Reddit, nossas comunidades no Discord (chat dos usuários, chat da comunidade, usado principalmente por colaboradores) ou o Stack Overflow.
-
Trata-se de uma issue duplicada? Antes de fechá-la, criamos um link para a issue original, o que também atualiza a issue original.
-
A issue tem informações suficientes para reproduzir o problema, e conseguimos reproduzi-lo? Se não, é provável que não possamos fazer nada e fecharemos a issue.
Nosso progresso até agora
Como você pode imaginar, à medida que nossa popularidade cresceu, também cresceu o número de issues abertas e fechadas em github.com/flutter/flutter (isso contempla todas as issues, exceto as do site, que são registradas em github.com/flutter/website):
Igualmente animador é o número de issues não com um rótulo correspondente a uma de nossas equipes de triagem secundária, como framework, engine ou plugin:
Dá para ver claramente onde começamos a envolver a Nevercode no nosso processo de triagem: primeiro no início de setembro, com grande progresso em meados de setembro, quando eles pegaram o ritmo.
Essa ênfase na triagem reflete nosso objetivo: não ter zero issues abertas, mas ter zero issues sem rótulo, para fornecer sinais adequados da nossa comunidade e priorizar melhor nosso trabalho. Conforme o Flutter continua crescendo em popularidade, esperamos ver um crescimento contínuo no número de issues abertas que exigem triagem, muitas das quais serão pedidos de novas funcionalidades da comunidade. Continuaremos usando rótulos para ajudar a determinar quais são os bugs que exigem atenção imediata, quais são os bugs que podemos adiar para a próxima versão beta ou estável e quais são os novos pedidos de funcionalidade.
Como você pode ajudar
Você pode ajudar a manter nosso banco de issues limpo e organizado com issues acionáveis. Ao registrar uma issue, considere o seguinte:
-
Não use o GitHub para suporte. Como parte da nossa triagem de issues, agora estamos fechando pedidos de suporte que aparecem no GitHub e redirecionando as pessoas para canais mais adequados. Nesses canais, você provavelmente vai encontrar alguém capaz de responder à sua pergunta, e as perguntas e respostas também ficam mais fáceis de encontrar para outros usuários.
-
Ajude com casos reproduzíveis: se for sua issue, certifique-se de ter um. Mesmo que não seja sua issue, aceitamos casos reproduzíveis de você também! Escrever casos reproduzíveis para bugs é uma ótima maneira de começar a aprender a usar o Flutter com exemplos do mundo real.
Atualize e vote em issues que são importantes para você.
-
Contribua com casos de teste para o repositório do Flutter. Essa é outra forma de começar a usar o Flutter e entrar na comunidade. Também nos ajuda a evitar regressões: embora todo código novo venha acompanhado de casos de teste, buscamos aumentar nossa cobertura de testes como boa prática. Se você tem interesse em contribuir dessa forma, pode dar uma olhada nas issues com o rótulo a: tests.
Considere ajudar na triagem de issues que outras pessoas registraram.
Somos muito gratos pelo apoio e pela confiança que você depositou ao investir seu tempo e suas ideias de aplicativos no Flutter. Damos as boas-vindas ao envolvimento da comunidade, seja registrando um bug ou uma funcionalidade que você gostaria de ver resolvida, seja criando um pull request para tornar o Flutter a plataforma com que você quer trabalhar. Obrigado!