Triangulando tickets

Django utiliza Trac para o gerenciamento do trabalho no código base. Trac é um jardim comunitário de bugs que pessoas encontraram e de funcionalidades que pessoas gostariam de ver adicionadas. Como em qualquer jardim, algumas vezes existem ervas daninhas para serem retiradas e algumas vezes existem flores e vegetais para serem colhidos. Nós precisamos da sua ajuda para separar um do outro, e no final todos nós nos beneficiamos.

Como em todos os jardins, nós podemos buscar a perfeição mas na realidade não existe algo assim. Até mesmo nos jardins mais puros existem lesmas e insetos. Em um jardim comunitário também existem pessoas que – com a melhor das intenções – fertilizam as ervas daninhas e envenenam as flores. É trabalho da comunidade como um todo se auto-gerenciar, reduzir problemas, e educar quem ingressa na comunidade de modo que eles possam contribuir e se tornar membros valiosos.

De modo similar, embora nós busquemos fazer com que o Trac seja uma representação perfeita do estado de progresso do Django, nós reconhecemos que isso simplesmente não vai acontecer. Ao distribuir a carga de manutenção do Trac para a comunidade, nós aceitamos que erros irão acontecer. Trac é “quase perfeito” e nós damos consentimento para o fato de que às vezes ele estará errado. Isso é normal Nós somos perfeccionistas com prazos.

Nós confiamos na comunidade para continuar participando, manter os tickets tão atualizados e corretos quanto for possível, e levantar problemas para discussão em nossas listas de email quando existirem desentendimentos ou confusão.

Django é um projeto comunitário, e cada contribuição ajuda. Nós não podemos fazer isso sem vocês!

Fluxo de triagem

Infelizmente, nem todos os relatos de bugs e solicitações de novas funcionalidades no rastreador de tickets fornecem todos os detalhes necessários. Um número de tickets possui patches, mas esses patches não atendem a todos os requisitos de um bom patch.

Uma forma de ajudar é fazendo uma triagem dos tickets que foram criados por outros usuários. O time do projeto e vários membros da comunidade trabalham nisso regularmente, mas ajuda adicional é sempre bem vinda.

A maior parte do fluxo de trabalho é baseada em torno do conceito de tickets estágios de triagem. Cada estágio descreve em que parte de seu clico de vida um ticket está em um dado momento. Além de várias tags, esse atributo nos diz claramente o que e quem o ticket está aguardando.

Já que uma imagem vale mais que mil palavras, vamos começar aqui:

Django's ticket triage workflow

Nós temos dois perfis neste diagrama:

  • Committers (também chamados de desenvolvedores do projeto): pessoas com permissões para fazer commit que são responsáveis por tomar decisões e integrar as contribuições da comunidade.

  • Agentes de triagem: qualquer pessoa na comunidade Django que escolher se envolver no processo de desenvolvimento do Django. Nossa instalação do Trac é intencionalmente deixada aberta para o público, e qualquer pessoa pode fazer a triagem dos tickets. Django é um projeto comunitário, e nós encorajamos triagens feitas pela comunidade.

Como exemplo, aqui nós podemos ver o ciclo de vida de um ticket comum:

  • Alice cria um ticket, e atualiza um patch incompleto (sem testes, implementação incorreta).

  • Bob revisou o patch, marcou ele como “Aceito”, “precisa de testes”, e “patch precisa de melhorias”, e deixou um comentário dizendo a Alice como ela poderia aprimorar o patch.

  • Alice atualiza o patch, adicionando testes (mas mantendo a implementação). Ela remove as duas tags.

  • Charlie revisa o patch e adiciona novamente a tag “patch precisa de melhorias” com outro comentário sobre como melhorar a implementação.

  • Alice atualiza o patch, corrigindo a implementação. Ela remove a tag “patch precisa de melhorias”.

  • Daisy revisa o patch, e marca ele como RFC

  • Jacob, um desenvolvedor do projeto, revisa o patch RFC, aplica ele em seu checkout, e faz o commit dele.

Alguns tickets precisam de bem menos feedback do que esse, mas então novamente outros tickets requerem muito, muito mais.

Estágios de triagem

Abaixo são descritos em mais detalhes os vários estágios que um ticket pode possuir durante o seu tempo de vida.

Não revisado

O ticket não foi revisado por ninguém que tenha se sentido qualificado para decidir se o ticket contém um problema válido, uma funcionalidade viável, ou se deveria ser fechado por qualquer uma das várias razões possíveis.

Aceito

A grande área cinzenta! O sentido absoluto de “aceito” é que o problema descrito no ticket é válido e está em algum estágio no processo de ser resolvido. Além disso existem vários considerações:

  • Aceito + Nenhuma Tag

    O ticket é válido, mas ninguém enviou um patch ainda. Geralmente isso significa que você pode começar a escrever um para ele com segurança. Isso costuma ser mais válido para os casos de bugs aceitos do que para novas funcionalidades aceitas. Um ticket para um bug que foi aceito significa que o problema verificado no ticket foi constatado por pelo menos um agente de triagem - e provavelmente deve ser corrigido se possível. Uma funcionalidade aceita pode significar apenas que um agente de triagem considerou a nova funcionalidade como algo bom de se ter, mas isso sozinho não representa um consenso ou implica que um patch deva ser aceito para essa funcionalidade. Procure mais feedback antes de escrever patchs extensos se você estiver em dúvida.

  • Aceito + Possui Patch

    O ticket está aguardando por pessoas para revisar o patch fornecido. Isso significa baixar o patch e usá-lo, verificando se ele contém testes e documentação, executando a suíte de testes incluídas com o patch, e deixando feedback no ticket.

  • Aceito + Possui Patch + Precisa ...

    Isso significa que o ticket foi revisado, e constatado que ele precisa de mais trabalho. “Precisa de testes” e “Precisa de documentação” são auto-explicativos. “Patch precisa de melhorias” geralmente estará acompanhado de um comentário no ticket explicando o que ele precisa para melhorar.

Ready For Checkin

O ticket foi revisado por um membro da comunidade diferente da pessoa que o forneceu e constatou-se que ele atende os requisitos para um patch pronto para o commit. Um committer agora precisará dar ao patch uma revisão final antes de ele ser commitado. Veja a FAQ Novos voluntários’ para “Meu ticket está eternamente em RFC! O que eu devo fazer?”

Someday/Maybe

Esse estágio não é mostrado no diagrama. Ele só é usado pelos desenvolvedores do projeto para manter em mente ideias maiores de funcionalidades requisitadas há um bom tempo.

Esses tickes são incomuns e no fim das contas menos úteis já que eles não descrevem problemas concretos e acionáveis. Eles são pedidos de melhorias que nós podemos considerar adicionar algum dia ao framework se um excelente patch é submetido. Eles não são uma grande prioridade.

Outros atributos de triagem

Um número de tags, aparecendo como checkboxes no Trac, podem ser ativdadas no ticket:

Possui patch

Isso significa que o ticket tem um patch associado. Eles serão revisados para saber se o patch é “bom”.

Os três campos seguintes (Precisa de documentação, Precisa de testes, Patch precisa de melhorias) se aplicam apenas se o patch foi submetido.

Precisa de documentação

Essa tag é usada para tickets com patches sem documentação associada. Documentação completa de funcionalidades é um pré-requisito antes de nós adicionarmos elas no código base.

Precisa de testes

Essa tag indica que o patch precisa de testes unitários. Novamente, isso é um pré-requisito para um patch válido.

Patch precisa de melhorias

Essa tag significa que embora o ticket tenha um patch, esse patch não está exatamente pronto para o checkin. Isso pode indicar que o patch não se aplica mais de forma clara, que existe uma falha na implementação, ou que o código não atende nossos padrões.

Easy Pickings

Tickets que podem precisar de patches pequenos e simples.

Tipo

Os tickets devem ser categorizados por tipo entre:

  • Nova funcionalidade

    Para adicionar algo novo.

  • Bug

    Para quando algo que já existe está quebrado ou não se comporta como esperado.

  • Limpeza/otimização

    Para quando nada está quebrado mas algo poderia ser mais limpo, melhor, rápido, forte.

Componente

Tickets devem ser classificados dentro de componentes indicando qual área do código base do Django eles pertencem. Isso faz com que os tickets fiquem melhor organizados e mais fáceis de encontrar.

Severidade

O atributo severidade é usado para identificar bloqueadores, isto é, problemas que devem ser corrigidos antes do lançamento da próxima versão do Django. Tipicamente esses problemas são bugs causando regressões de versões anteriores ou potencialmente causando perdas de dados severas. Este atributo é muito raramente usado e a grande maioria dos tickets tem um nível de severidade “Normal”.

Versão

É possível usar o atributo “versão” para indicar em qual versão o bug relatado foi identificado.

UI/UX

Esta tag é utilizada para tickets que estão relacionados a questões de interface de usuário e de experiência de usuário. Por exemplo, essa tag seria apropriada para funcionalidades que os usuários podem ver nos formulários ou na interface do admin.

Cc

Você pode adicionar o seu username ou endereço de email neste campo para ser notificado quando novas contribuições forem feitas ao ticket.

Keywords

Com esse campo você poderá adicionar rótulos a um ticket com múltiplas palavras-chave. Isso pode ser útil, por exemplo, para agrupar vários tickets de uma mesmo tema. Palavras-chave podem ser separadas tanto por vírgulas quanto por espaços. Buscas por palavras-chave encontram suas respectivas strings independentemente do local. Por exemplo, clicando em um ticket com a palavra-chave “formulário” irá trazer tickets similares taggeados com palavras-chave contendo strings como “formset”, “modelformset”, e “ManagamentForm”.

Fechando Tickets

Quando um ticket completa o seu ciclo de vida útil, chegou a hora de fechá-lo. Porém, fechar um ticket é uma grande responsabilidade. Você precisa ter certeza que o problema está realmente resolvido, e você precisa manter em mente que quem reportou o ticket pode não gostar de ter tido o seu ticket fechado (a não ser que o problema tenha sido corrigido, claro). Se você não tem certeza se deve fechá-lo, ao invés fechá-lo, deixe um comentário com sua opinião a respeito.

Se você realmente for fechar um ticket, você sempre deve ter certeza de que:

  • Certifique-se de que o problema foi resolvido.

  • Deixe um comentário explicando a decisão de fechar o ticket.

  • Se existe uma forma de melhorar o ticket para que ele seja reaberto, informe como.

  • Se o ticket está duplicado, faz uma referência ao ticket original. Também faça uma referência cruzada no ticket fechado deixando um comentário no ticket original – isso permite acessar mais informações sobre o bug relatado ou a funcionalidade solicitada.

  • Seja educado Ninguém gosta de ter o seu ticket fechado. Isso pode ser frustrante e até mesmo desencorajante. A melhor forma de evitar que pessoas deixem de contribuir com o Django é sendo gentil e educado oferecendo sugestões sobre como eles podem melhorar esse ticket e outros tickets no futuro.

Um ticket pode ser resolvido de diversas maneiras:

  • Corrigido

    Utilizado pelos desenvolvedores do projeto quando um patch foi incorporado ao Django e o problema corrigido.

  • Inválido

    Utilizado caso constatado que o ticket estava incorreto. Isso significa que o problema relatado no ticket é na verdade o resultado de um erro cometido pelo usuário, ou descreve um problema com algo não relacionado ao Django, ou se não é um relato de um bug ou a solicitação de uma nova funcionalidade (por exemplo, alguns novos usuários enviam dúvidas de suporte como tickets).

  • wontfix

    Usado quando o desenvolvedor do projeto decide que a funcionalidade não é apropriada para consideração no Django. Isso geralmente é decidido após de uma discussão na lista de email django-developers. Sinta-se livre para iniciar ou se juntar em uma discussão de tickets do tipo “wontfix” na lista django-developers, mas por favor não reabra tickets fechados como “wontfix” por um desenvolvedor do projeto.

  • Duplicado

    Usado quando outro ticket cobre o mesmo problema. Fechando tickets duplicados, nós mantemos toda a discussão em um só local, o que ajuda todo mundo.

  • worksforme

    Usado quando o ticket não contém detalhes o suficiente para replicar o bug original.

  • needsinfo

    Usado quando o ticket não contém informação o suficiente para replicar o problema relatado mas ainda tem o potencial de ser válido. O ticket deve ser reaberto quando mais informações foram fornecidas.

Se você acha que o ticket foi fechado indevidamente – porque você ainda está tendo problemas, ou o problema apareceu em outro lugar, ou os agentes de triagem cometeram um erro – por favor reabra o ticket fornecendo mais informações. Novamente, por favor não reabra tickets que foram marcados com a tag “wonfix” pelos desenvolvedores do projeto, nesses casos traga o problema para lista django-developers.

Como eu posso ajudar com a triagem?

O processo de triagem é controlado primeiramente pelos membros da comunidade. De verdade, QUALQUER PESSOA pode ajudar.

Desenvolvedores do projeto podem fornecer feedback em problemas nos quais eles estejam familiarizados, ou tomar decisões em problemas controversos, mas eles não são responsáveis pela triagem em geral.

Para contribuir, comece criando uma conta no Trac. Se você tem uma conta mas esqueceu a sua senha, você pode resetá-la usando a página de recuperação de senha.

A partir disso, você poderá ajudar com:

  • Fechando tickets do tipo “Unreviewed” como “invalid”, “worksforme” ou “duplicate”.

  • Fechando tickets “Inreviewed” como “needsinfo” quando a descrição é muito esparsa para ser acionável, ou quando eles são solicitações de funcionalidades requerindo uma discussão em django-developers.

  • Corrigindo as flags “Needs tests”, “Needs documentation”, ou “Has patch” para tickets onde eles são setados incorretamente.

  • Adicionando a flag “Easy pickings” para tickets que são pequenos e relativamente simples.

  • Adicionando um tipo para os tickets que ainda não foram categorizados.

  • Verificando se tickets antigos ainda são válidos. Se o ticket não possui atividade em um longo período, é possível que o problema tenha sido corrigido mas o ticket ainda não foi fechado.

  • Identificando tendências e temas nos tickets. Se existem vários relatos de bugs sobre uma determinada parte do Django, isso pode indicar que nós deveríamos refatorar essa parte do código. Se a tendência está emergindo, você pode trazer ela para discussão (referenciando os tickets relevantes) em django-developers.

  • Verifique se os patches submetidos por outros usuários estão corretos. Se eles estiverem e se também contém documentações e testes apropriados então mova os para o estágio “Ready for Checkin”. Se eles não estão corretos deixe um comentário explicando porque e ative as flags correspondentes (“Patch needs improvement”, “Needs tests”, etc.).

Nota

A página de reports contém links para muitas consultas úteis no Trac, incluindo várias que podem ser usadas na triagem dos tickets e na revisão de patches como sugerido acima.

Você também pode encontrar mais em novos-voluntários.

Porém, nós pedimos o seguinte de todos os membros da comunidade trabalhando no banco de dados de tickets:

  • Por favor não feche tickets usando “wontfix”. Os desenvolvedores do Django determinaram o destino final de um ticket, geralmente depois de uma consulta a comunidade.

  • Por favor não promova seus próprios tickets para “Ready for Checkin”. Você pode marcar os tickets de outras pessoas que você tenha revisado como “Ready for Checkin”, mas você deve ter pelo menos um membro da comunidade revisando um patch que você tenha submetido.

  • Por favor não reverta uma decisão que tenha sido tomada por um desenvolvedor do projeto. Se você não concordar com a decisão que ele foi tomada, por favor poste uma mensagem em django-developers.

  • Se vocẽ não tem certea se você deve ou não fazer uma alteração, não faça a alteração e ao invés disso deixe um comentário com suas reflexões no ticket, ou poste uma mensagem em django-developers. Não tem problema não ter certeza, mas suas considerações ainda são válidas.

Bisseccionando uma regressão

Uma regressão é um bug que está presente em alguma versão nova do Django mas não em versões mais antigas. Uma informação extremamente valiosa é o commit que introduziu a regressão. Saber qual foi o commit que causou a mudança de comportamento ajuda a identificar se a mudança foi intencional ou se ela foi um efeito colateral inesperado. Aqui vamos mostrar como você pode determinar isso.

Comece escrevendo um teste de regressão na suíte de testes do Django para o problema. Por exemplo, nós vamos imaginar que nós estamos debugando uma regressão nas migrações. Depois de você ter escrito o teste e confirmado que ele falha na última versão da master, coloque-o em um arquivo separado que você possa rodar sozinho. Para o nosso exemplo, nós vamos imaginar que nós criamos o arquivo tests/migrations/test_regression.py, que pode ser rodado com:

$ ./runtests.py migrations.test_regression

Em seguida, marque o ponto atual no histórico como sendo “ruim” já que o teste falhou:

$ git bisect bad
You need to start by "git bisect start"
Do you want me to do it for you [Y/n]? y

Agora, nós precisamos encontrar um ponto no histórico do git anterior a introdução da regressão (por exemplo, um ponto onde os testes passam). Utilize algo como git checkout HEAD~100 para fazer checkout de uma revisão anterior (100 commits antes, neste caso). Verifique se os testes falham. Se isso ocorrer, marque o ponto como sendo “ruim” (“git bisect bad”), então faça checkout de uma revisão mais antiga e verifique novamente. Quando você encontrar uma revisão em que os seus testes passam, marque ela como “boa”:

$ git bisect good
Bisecting: X revisions left to test after this (roughly Y steps)
...

Agora nós estamos prontos para a parte divertida: usar o comando git bisect run para automatizar o resto do processo:

$ git bisect run python runtests.py migrations.test_regression

Você deverá ver o git bisect usando uma busca binária para automaticamente fazer checkout de revisões entre os commits bons e os commits ruins até que ele encontre o primeiro commit “ruim” onde o teste falha.

Agora, mostre os seus resultados no ticket do Trac, e por favor inclua o teste de regressão como um anexo. Quando alguém escreve uma correção para o bug, eles já terão o seu teste como uma referência de por onde começar.

Back to Top