# Documentação Django 6.0.7

# Triagem de tickets

Django uses Trac for managing the work on the code base. Trac is a community-tended garden of the bugs people have found and the features Django has decided to add. As in any garden, sometimes there are weeds to be pulled and sometimes there are flowers and vegetables that need picking. We need your help to sort out one from the other, and in the end, we all benefit together.

Like all gardens, we can aspire to perfection, but in reality there’s no such thing. Even in the most pristine garden there are still snails and insects. In a community garden there are also helpful people who – with the best of intentions – fertilize the weeds and poison the roses. It’s the job of the community as a whole to self-manage, keep the problems to a minimum, and educate those coming into the community so that they can become valuable contributing members.

Similarly, while we aim for Trac to be a perfect representation of the state of Django’s progress, we acknowledge that this will not happen. By distributing the load of Trac maintenance to the community, we accept that there will be mistakes. Trac is “mostly accurate”, and we give allowances for the fact that sometimes it will be wrong. That’s okay. We’re perfectionists with deadlines.

We rely on the community to keep participating, keep tickets as accurate as possible, and raise issues for discussion on the Django Forum when there is confusion or disagreement.

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

## Fluxo de triagem

Unfortunately, not all reports in the ticket tracker provide all the required details. A number of tickets have proposed solutions, but those don’t necessarily meet all the requirements adhering to the guidelines for contributing.

One way to help out is to triage tickets that have been created by other users.

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:

We have four roles in this diagram. Maintainers (also known as Fellows) usually take part in all of them, but anyone in the Django community can participate in any role except merger. The merger role is granted by a vote of the Steering Council.

- Triagers: anyone can take on this role by checking whether a ticket describes a real issue and keeping the tracker organized.

- Bug fixers: anyone can contribute by opening a pull request and working on a solution for a ticket.

- Reviewers: anyone can review pull requests and suggest improvements.

- Mergers: people with commit access who make the final decision to merge a change.

When we say anyone, we mean you!

Our Trac system and GitHub repositories are intentionally open to the public. Anyone can help by working on tickets, triaging tickets and reviewing changes. Django is a community project, and we encourage triage and collaboration by the community. We truly want you to help!

For example, here’s the typical lifecycle of a ticket:

- Alice creates a ticket and opens an incomplete pull request (missing tests, incorrect implementation).

- Bob reviews the pull request, marks the ticket as “Accepted”, sets the flags “needs tests” and “patch needs improvement”, and leaves a comment explaining how Alice can improve the patch. This puts the ticket automatically into the “waiting on author” queue within the “accepted” stage.

- Alice updates the pull request, adding tests (but not yet fixing the implementation), and removes the two flags. The ticket moves into the “needs PR review” queue.

- Charlie reviews the pull request, sets the “patch needs improvement” flag again, and leaves another comment suggesting changes to the implementation. The ticket moves back to the “waiting on author” queue.

- Alice updates the pull request again, this time fixing the implementation, and removes the “patch needs improvement” flag. The ticket moves once more into the “needs PR review” queue.

- Daisy reviews the pull request and marks the ticket as “Ready for checkin”.

- Jacob, a merger, reviews and merges the pull request.

Some tickets move through these steps quickly, while others take more time and discussion. Each contribution helps Django improve.

## 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

The ticket has not been reviewed by anyone who felt qualified to make a judgment about whether the ticket contained a valid issue or ought to be closed for any reasons. Unreviewed tickets appear in the “triage” queue.

Unreviewed tickets may receive additional refinement before being accepted. Unless you are both the author of the ticket and intending to submit a patch, unreviewed tickets should not be claimed.

### Aceito

The absolute meaning of “accepted” is that the issue described in the ticket is valid and actionable. It is broken out into three queues:

- Needs Patch (Accepted + No Flags)

  The ticket is valid, but no one has submitted a patch for it yet. Often this means you could safely start writing a fix for it. This is generally more true for the case of accepted bugs than accepted features. A ticket for a bug that has been accepted means that the issue has been verified by at least one triager as a legitimate bug - and should probably be fixed if possible.

  For new features, accepted tickets should only exist after the idea has gone through the appropriate process for suggesting new features and received community and Steering Council approval, or been accepted in a DEP.

- Needs PR Review (Accepted + Has Patch)

  The ticket is waiting for people to review the supplied solution. This means downloading the patch and trying it out, verifying that it contains tests and docs, running the test suite with the included patch, and leaving feedback on the ticket.

- Waiting On Author (Accepted + Has Patch + Needs fixes)

  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.

### Pronto para Checkin

The ticket was reviewed by any member of the community other than the person who supplied the patch and found to meet all the requirements for a commit-ready contribution. A merger now needs to give a final review prior to being committed.

There are a lot of pull requests. It can take a while for your patch to get reviewed. See the contributing code FAQ for some ideas here.

### Algum Dia/Talvez

This stage isn’t shown on the diagram. It’s used sparingly to keep track of long-term changes.

These tickets are uncommon and overall less useful since they don’t describe concrete actionable issues.

## Outros atributos de triagem

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

### Possui patch

This means the ticket has an associated solution. These will be reviewed to ensure they adhere to the documented guidelines.

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

This flags the patch as needing associated unit tests. Again, this is a required part of a valid contribution.

### Patch precisa de melhorias

This flag means that although the ticket has a solution, it’s not quite ready for checkin. This could mean the patch no longer applies cleanly, there is a flaw in the implementation, or that the code doesn’t meet our standards.

### Escolhas Fáceis

Tickets that would require small, easy, changes.

### 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

The severity attribute is used to identify blockers, that is, issues that should get fixed before releasing the next version of Django. Typically those issues are bugs causing regressions from earlier versions or potentially causing severe data losses. This attribute is quite rarely used and the vast majority of tickets have a severity of “Normal”.

### Versão

The version attribute indicates the earliest version in which the bug was reproduced. During triage, this field can be updated, but there is no need to make further updates when that version goes out of support. The field should not be reset to “dev” to show the issue still exists: instead, the tested commit hash can be noted in a comment.

### 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 nome de usuário ou endereço de email neste campo para ser notificado quando novas contribuições forem feitas ao ticket.

### Palavras-chave

With this field you may label a ticket with multiple keywords. This can be useful, for example, to group several tickets on the same theme. Keywords can either be comma or space separated. Keyword search finds the keyword string anywhere in the keywords. For example, clicking on a ticket with the keyword “form” will yield similar tickets tagged with keywords containing strings such as “formset”, “modelformset”, and “ManagementForm”.

## Fechando Tickets

When a ticket has completed its useful lifecycle, it’s time for it to be closed. Closing a ticket is a big responsibility, though. You have to be sure that the issue is really resolved, and you need to keep in mind that the reporter of the ticket may not be happy to have their ticket closed (unless it’s fixed!). If you’re not certain about closing a ticket, leave a comment with your thoughts instead.

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

    Used once a patch has been rolled into Django and the issue is fixed.

- 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

    Used when someone decides that the request isn’t appropriate for consideration in Django. Sometimes a ticket is closed as “wontfix” with a request for the reporter to start a discussion on the Django Forum if they feel differently from the rationale provided by the person who closed the ticket. Other times, a discussion precedes the decision to close a ticket. Always use the forum to get a consensus before reopening tickets closed as “wontfix”.

- needsnewfeatureprocess

    Used when the ticket merits a new feature, which will need to get community input and support. See the process for suggesting new features.

- 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.

If you believe that the ticket was closed in error – because you’re still having the issue, or it’s popped up somewhere else, or the triagers have made a mistake – please reopen the ticket and provide further information. Again, please do not reopen tickets that have been marked as “wontfix” or “needsnewfeatureprocess”. For “wontfix” tickets, bring the issue to the Django Forum instead. For “needsnewfeatureprocess” tickets, propose the feature through the new features process.

## How can I help with development?

The development process is primarily driven by community members. Really, ANYONE can help.

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:

- Closing “Unreviewed” tickets as “invalid”, “worksforme”, “duplicate”, “wontfix”, or “needsnewfeatureprocess”.

- Closing “Unreviewed” tickets as “needsinfo” when the description is too sparse to be actionable.

- 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.

- Identifying trends and themes in the tickets. If there are a lot of bug reports about a particular part of Django, it may indicate we should consider refactoring that part of the code. If a trend is emerging, you should raise it for discussion (referencing the relevant tickets) on the Django Forum.

- Verify if solutions submitted by others are correct. If they are correct and also contain appropriate documentation and tests then move them to the “Ready for Checkin” stage. If they are not correct then leave a comment to explain why and set the corresponding flags (“Patch needs improvement”, “Needs tests” etc.).

Nota

The Reports page contains links to many useful Trac queries, including several that are useful for triaging tickets and reviewing proposals as suggested above.

You can also find more Conselho aos novos voluntários.

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

- Please don’t promote your own tickets to “Accepted”. Another community member should review the report and set this stage after reproducing and confirming the issue.

- Please don’t promote your own tickets to “Ready for checkin”. You may mark other people’s tickets that you’ve reviewed as “Ready for checkin”, but you should get at minimum one other community member to review a patch that you submit.

- Please don’t reverse a decision without posting a message to the Django Forum to find consensus.

- If you’re unsure if you should be making a change, don’t make the change but instead leave a comment with your concerns on the ticket, or post a message to the Django Forum. It’s okay to be unsure, but your input is still valuable.

## 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.

Begin by writing a regression test for Django’s test suite for the issue. For example, we’ll pretend we’re debugging a regression in migrations. After you’ve written the test and confirmed that it fails on the latest main branch, put it in a separate file that you can run standalone. For our example, we’ll pretend we created `tests/migrations/test_regression.py`, which can be run with:

    $ ./runtests.py migrations.test_regression

Next, we mark the current point in history as being “bad” since the test fails:

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

Now, we need to find a point in git history before the regression was introduced (i.e. a point where the test passes). Use something like `git checkout HEAD~100` to check out an earlier revision (100 commits earlier, in this case). Check if the test fails. If so, mark that point as “bad” (`git bisect bad`), then check out an earlier revision and recheck. Once you find a revision where your test passes, mark it as “good”:

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

Now we’re ready for the fun part: using `git bisect run` to automate the rest of the process:

    $ git bisect run tests/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.

## Reviewing patches

A great way to learn the Django codebase is to help review patches. It allows you to focus on a fixed scope of Django with a particular perspective. Plus, Django tends to receive more patches than it can review which causes the review queue to build up. Contributors can help Django tremendously by reviewing patches.

The review queue is defined by tickets in Trac that are in the “Accepted” state with the flag “has patch” set and the flags “patch needs improvement”, “needs tests” and “needs documentation” unset. There is also a set of Pull Requests in GitHub with the “no ticket” label that can be reviewed.

### Code review process

The general process to reviewing a patch for Django is as follows:

1. Pick a patch to review. This can be from the review queue or the Pull Requests in GitHub with the “no ticket” label. If you’re new, pick a specific component to stick with. Django is a big codebase, so it’s best to contribute consistently with a narrow focus and grow it slowly.

2. Pull the branch. See the Manipulando pull requests, including the git alias to make checking out other pull requests easier.

3. Check the tests. If the ticket is for a bug, there should be a regression test. Confirm that the test fails if the change is reverted. Check that the tests are adequately covering the code and logic as well. See Contribution checklist.

4. Test in your own Django project. See Instalando a versão de desenvolvimento. for how. Explore the user interface and user experience with the change. Does it feel right? Can you break it? Another approach is to assume everything is wrong. Can you demonstrate to yourself that each piece is correct?

5. Check the documentation. Is the documentation understandable? Does it provide the information the reader needs at that moment? Does it read well? Is it consistent with the documentation before and after it? See Build the documentation locally.

6. Are you happy with the patch? This is fairly subjective, but that’s fine. You should ask, does the approach make sense to you and is there another way to do it that’s better? Also ask yourself, is the scope of the change appropriate? Are things named appropriately? Renaming things is slow and challenging in Django, so we should try to get it right from the start. Are there backwards compatibility concerns? Lastly, are there any other general concerns such as things that may worry you or that should be looked into?

7. Review your feedback. Before you submit your feedback, consider the feedback you want to share. It takes courage to open a Pull Request, we should be thoughtful and considerate of the leap the author has made. If there are nitpicky or small suggestions, use GitHub’s suggestion feature. If the approach isn’t what you expected, consider asking the author why before requesting several changes. Seek to understand their reasoning first.

8. Submit feedback on GitHub and update flags, “patch needs improvement”, “needs tests”, and “needs documentation”, as needed. This will move the ticket to the “waiting for author” queue. If you have given a specific type of code review, please indicate that on the Pull Request.

### Types of code reviews

Not everyone will or should give the same type of code review. Having a diverse set of opinions and experiences helps Django be better. If you are providing a specific review, please indicate that on the Pull Request in GitHub. Below are some of the types of code review you can perform:

- Accessibility review. Does it conform to our Accessibility standards?

- Patch style and contribution process review.

- Usability and developer experience review.

  - Use the change and provide feedback from that experience.

  - Are the APIs and documentation accessible and well explained?

- Domain expertise review. Do you have a personal expertise that is relevant such as databases, HTTP, security, etc?

- Benchmarking and performance review. There are benchmarking tests, but sometimes changes require additional testing.

  - Utilize django-asv benchmarks to check performance over time.

  - Run benchmark tests by labeling the pull request with “benchmark”.