Enviando patches

Nós estamos sempre gratos por patches para o código do Django. De fato, relatos de bugs com um respectivo patch serão corrigidos muito mais rápido do que os bugs relatados sem um patch.

Correções de ortografia e mudanças triviais na documentação

Se você está corrigindo um problema realmente trivial, por exemplo, mudando uma palavra na documentação, a melhor maneira de providenciar o patch é usando um pull request sem um ticket no Trac associado.

Veja a Trabalhando com Git e GitHub para mais detalhes sobre como usar os pull requests.

“Reinvindicando” tickets

Em um projeto open-source com voluntários espalhados por todo o mundo, é importante gerenciar a comunicação de forma eficiente de modo que o trabalho não seja duplicado e voluntários possam ser o mais eficiente quanto possível.

Por tanto, nossa política é que os voluntários “reinvindiquem” os tickets de modo a permitir que os desenvolvedores do projeto saibam que aquele bug em específico ou funcionalidade está sendo atendida.

Se você identificou uma contribuição que você gostaria de fazer e se você é capaz de fazer essa correção (capacidade aqui mensurada pelas suas abilidades para programar, conhecimento de como o Django funciona internamente e tempo disponível), reinvindique ele seguindo os passos abaixo:

  • Faça login usando a sua conta no GitHub ou criando uma conta no nosso sistema de tickets. Se você tem uma conta mas esqueceu sua senha, você pode resetá-la usando a página de recuperação de senha.

  • Se um ticket para um problema não foi criado ainda, crie um no nosso rastreador de tickets.

  • Se o ticket para esse problema já existe, certifique-se de que ninguém mais o reinvindicou. Para fazer isso, procure na seção “Owned by” do ticket. Se ele estiver atribuído para “nobody”, então ele está disponível para reinvindicação. Caso contrário, outra pessoa já pode estar trabalhando nesse ticket. Busque outro bug/funcionalidade para trabalhar em cima ou contate o desenvolvedor trabalhando nesse ticket para oferecer a sua ajuda. Se o ticket já foi atribuído por semanas ou meses sem qualquer atividade, provavelmente é seguro reatribuí-lo para você.

  • Acesse a sua conta, se você não tem uma ainda, clicando em “GitHub Login” ou “DjangoProject Login” no topo esquerdo da página de tickets.

  • Reinvindique o ticket clicando na opção “assign to myself” em “Action” quase no final da página do ticket, e depois clique em “Submit changes”.

Nota

A Django Software Foundation requer que todas as contribuições maiores que um patch trivial assinem e enviem o Contributor License Agreement, isso garante que a Django Software Foundation tenha a licença para todas as contribuições permitindo assim uma licença limpa para todos os usuários.

Responsabilidade de quem reinvindicou um Ticket

Quando você reinvindicar um ticket, você terá a responsabilidade de trabalhar nele em uma quantidade de tempo razoável. Se você não tem tempo para trabalhar nele, ou abra mão dele ou nem se quer faça a reinvindicação do ticket em primeiro lugar!

Se não existir sinal de progresso em um ticket reinvindicado em particular por uma semana ou duas, outros desenvolvedores podem pedir para você abrir mão da reinvindicação do ticket de modo que ele não esteja mais monopolizado e alguém mais possa reinvindicá-lo novamente.

Se você reinvindicou um ticket e está demorando um bom tempo (dias ou semanas) para programar, mantenha todo mundo atualizado postando comentários no ticket. Se você não fornecer atualizações regulares, e você não responder a um pedido por relatório de progresso, a sua reinvindicação ao ticket poderá ser revogada.

Como sempre, mais comunicação é melhor do que menos comunicação.

Quais tickets devem ser reinvindicados?

Claro, passar por todas as etapas de reinvindicar um ticket pode ser excessivo em alguns casos.

No caso de pequenas mudanças, como correções de ortografia na documentação ou pequenos bugs que levarão apenas alguns minutos para corrigir, você não precisa passar por todas as etapas do processo de reinvindicação de tickets. Apenas envie o seu patch e termine logo com isso.

Claro, é sempre permitido, independentemente de quem fez a reinvindicação do ticket ou não, enviar patches para um ticket se você já tem um pronto.

Estilo de um patch

Certifique-se de que qualquer contribuição que você fizer preencha pelo menos os requisitos abaixo:

  • O código necessário para corrigir um problema ou adicionar uma funcionalidade é uma parte essencial de um patch, mas ele não é a única. Um bom patch também deve incluir um teste de regressão para validar o comportamento que foi corrigido e para prevenir o problema de aparecer novamente. Além disso, se alguns tickets são relevantes para o código que você escreveu, mencione os números desses tickets em algum comentário do teste de modo que alguém possa facilmente encontrar as discussões relevantes depois do seu patch ser commitado, e o ticket for fechado.

  • Se o código associado com o patch adiciona uma nova funcionalidade, ou modifica o comportamento de uma funcionalidade existente, o patch também deve conter documentação.

Quando você achar que o seu trabalho está pronto para ser revisado, envie um pull request pelo GitHub. Por favor revise o ptch você mesmo usando nossa checklist de revisão de patchs primeiro.

Se você não pode enviar um pull request por alguma razão, você também pode usar patches dentro do Trac. Quando usar esse estilo, siga as orientações a seguir:

  • Envie os patches dentro do formato retornado por um comando git diff.

  • keAnexe os patches a um ticket dentro do ticket tracker, usando o botão “attach file”. Por favor não coloque o patch na descrição do ticket ou dentro de um comentário a não ser que seja um patch de uma linha.

  • Nomeie o arquivo de patch com a extensão .diff; isso permitirá que o rastreador de tickets aplique o estilo de formatação de sintaxe correto, o que ajuda muito.

Independentemente da maneira pela qual você irá enviar o seu trabalho, siga os passos a seguir:

  • Certifique-se de que o seu código preenche todos os requisitos em nosso checklist de revisão de patchs.

  • Marque a caixa “Has patch” no ticket e certifique-se de que as caixas “Needs documentation”, “Needs tests”, and “Patch needs improvement” não estão marcadas. Isso fará com que o ticket seja exibido na pilha “Patches needing review” na Development dashboard.

Patches não triviais

Patch “não trivial” é um patch maior que uma simples correção de um bug. É um patch que introduz funcionalidades ao Django e faz algum tipo de decisão de projeto.

Se você estiver enviando um patch não trivial, inclua evidências de que alternativas foram discutidas na lista django-developers.

Se você não tem certeza se o seu patch deveria ou não ser considerado como não trivial, pergunte.

Depreciando uma funcionalidade

Existem algumas razões para que um código no Django posso estar depreciado:

  • Se a funcionalidade foi melhorada ou modificada de modo a não ser mais compatível com versões anteriores, a antiga funcionalidade ou comportamento pode ser depreciada.

  • Algumas vezes o Django inclui um backport de uma biblioteca Python que não está incluída na versão do Python suportada atualmente pelo Django. Quando o Django não precisa mais dar suporte a versão antiga do Python que não fornece a biblioteca, essa biblioteca será depreciada no Django.

Como a política de depreciação descreve, a primeira release do Django que deprecia a funcionalidade (“A.B”) deve gerar um warning RemovedInDjangoXXWarning (onde XX é a versão do Django em que a funcionalidade será removida) quando a funcionalidade depreciada é invocada. Assumindo que nós temos uma boa cobertura de código, esses warnings são convertidos para erros quando executamos a suíte de testes com warnings ativados: python -Wall runtests.py.

O primeiro passo é remover qualquer uso do comportamento depreciado no próprio Django. Depois você pode silenciar os warnings nos testes que testam o comportamento depreciado usando o decorator ignore_warnings, na classe ou diretamente nos testes:

  1. Em um teste em particular:

    from django.test import ignore_warnings
    from django.utils.deprecation import RemovedInDjangoXXWarning
    
    @ignore_warnings(category=RemovedInDjangoXXWarning)
    def test_foo(self):
        ...
    
  2. Para um caso de teste inteiro:

    from django.test import ignore_warnings
    from django.utils.deprecation import RemovedInDjangoXXWarning
    
    @ignore_warnings(category=RemovedInDjangoXXWarning)
    class MyDeprecatedTests(unittest.TestCase):
        ...
    
Changed in Django 1.8:

Versões prévias do Django tinham algumas classes Ignore*DeprecationWarningsMixin` para prevenir warnings de aparecer. Esses foram substituiídos pelo decorator ignore_warnings.

Você também pode adicionar um teste para o warning de depreciação, Você terá que desabilitar o comportamento de tratar “warning como erro” nos seus testes fazendo o seguinte:

import warnings

def test_foo_deprecation_warning(self):
    with warnings.catch_warnings(record=True) as warns:
        warnings.simplefilter('always')  # prevent warnings from appearing as errors
        # invoke deprecated behavior

    self.assertEqual(len(warns), 1)
    msg = str(warns[0].message)
    self.assertEqual(msg, 'Expected deprecation message')

Finalmente, existem algumas atualizações na documentação do Django para fazer:

  1. Se a funcionalidade existente está documentada, marque ela como depreciada na documentação usando a anotação .. deprecated:: A.B. Inclua uma curta descrição e uma nota sobre o caminho para atualizar se possível.

  2. Adicione uma descrição de comportamento depreciado, e o caminho de atualização se possível, para as notas da release atual (docs/releases/A.B.txt) abaixo do header “Features deprecated in A.B”.

  3. Adicione uma nova entrada na linha do tempo de depreciação (docs/internals/deprecation.txt) abaixo da versão apropriada descrevendo qual código será removido.

Uma vez que você tenha completado esses passos, você já concluiu com a depreciação. Em cada feature release, todos os RemovedInDjangoXXWarning que coincidam com a nova versão são removidos.

Patches JavaScript

para informação sobre patches em JavaScript, veja a documentação Patches JavaScript .

Checklist de Revisão de Patches

Utilize esta checklist para revisar um pull request. Se você está revisando um pull request que não é seu e ele passar em todos os critérios abaixo, por favor altere o estágio de triagem do ticket no Trac correspondente para “Ready for Checkin”. Se você deixou comentários no ticket para melhorias no pull request, por favor marque a flag apropriada no Trac baseado nos resultados da sua revisão: “Patch needs improvement”, “Needs documentation”, and/or “Needs tests”. Se o tempo e interesse permitir, desenvolvedores do projeto fazem uma revisão final dos tickets marcados como “Ready for checkin” e ou realização o commit do patch ou movê-lo de volta para “Accepted” se mais trabalho tiver que ser feito. Se você está querendo se tornar um core developer, fazer revisões dos patches é uma grande maneira de ganhar confiança.

Procurando um patch para revisar? Veja a seção “Patches needing review” do Django Development Dashboard. Querendo que o patch que você desenvolveu seja revisado? Certifique-se de que as flags do ticket no Trac foram setadas corretamente de modo que ele apareça nessa fila.

Documentação

Bugs

  • Existe um teste de regressão apropriado (o teste deve falhar antes da correção ser aplicada)?

Novas funcionalidades

  • Existem testes para “exercitar” todo o código recém-criado?

  • Existe uma nota de release em docs/releases/A.B.txt?

  • Existe documentação para a funcionalidade e ela está anotada de modo apropriado com .. versionadded:: A.B ou .. versionchanged:: A.B?

Depreciando uma funcionalidade

Veja o guia depreciando uma funcionalidade.

Todo código muda

  • O estilo de código atende as nossas regras? Existem quaisquer erros gerados pelo flake8?

  • Se a mudança não é compatível com versões anteriores de modo algum, existe um aviso nas notas de release (docs/releases/A.B.txt)?

  • A suíte de testes do Django está passando? Peça em #django-dev para que um desenvolvedor do projeto construa o pull request no nosso servidor de integração contínua.

Todos os tickets

Back to Top