We’re always grateful for contributions to Django’s code. Indeed, bug reports\nwith associated contributions will get fixed far more quickly than those\nwithout a solution.
\nSe 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.
\nSee Trabalhando com Git e GitHub for more\ndetails on how to use pull requests.
\nEm 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.
\nPor 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.
\nSe 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:
\nLog in using your GitHub account or create an account in our ticket\nsystem. If you have an account but have forgotten your password, you can\nreset it using the password reset page.
If a ticket for this issue doesn’t exist yet, create one in our\nticket tracker. Remember that proposals for new features should follow\nthe process for suggesting new features.
If a ticket for this issue already exists and has been accepted, make sure\nnobody else has claimed it. To do this, look at the “Owned by” section of\nthe ticket. If it’s assigned to “nobody,” then it’s available to be claimed.\nOtherwise, somebody else may be working on this ticket. Either find another\nbug/feature to work on, or contact the developer working on the ticket to\noffer your help. If a ticket has been assigned for weeks or months without\nany activity, it’s probably safe to reassign it to yourself. If a ticket\nhasn’t been approved yet, join the conversation.
Log into your account, if you haven’t already, by clicking “GitHub Login”\nor “DjangoProject Login” in the upper left of the ticket page. Once logged\nin, you can then click the “Modify Ticket” button near the bottom of the\npage.
Claim the ticket by clicking the “assign to” radio button in the “Action”\nsection. Your username will be filled in the text box by default.
Finally, click the “Submit changes” button at the bottom to save.
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!
\nSe 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.
\nSe 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.
\nComo sempre, mais comunicação é melhor do que menos comunicação.
\nGoing through the steps of claiming tickets is overkill in some cases.
\nIn the case of small changes, such as typos in the documentation or small bugs\nthat will only take a few minutes to fix, you don’t need to jump through the\nhoops of claiming tickets. Submit your changes directly and you’re done!
\nIt is always acceptable, regardless of whether someone has claimed it or not,\nto link proposals to a ticket if you happen to have the changes ready.
\nCertifique-se de que qualquer contribuição que você fizer preencha pelo menos os requisitos abaixo:
\nThe code required to fix a problem or add a feature is an essential part\nof a solution, but it is not the only part. A good fix should also include a\nregression test to\nvalidate the behavior that has been fixed and to prevent the problem from\narising again.
If the code adds a new feature, or modifies the behavior of an existing\nfeature, the change should also contain documentation.
When you think your work is ready to be reviewed, send a GitHub pull\nrequest. If you can’t\nsend a pull request for some reason, you can also use patches in Trac. When\nusing this style, follow these guidelines.
\nEnvie 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:
\nMake sure your code fulfills the requirements in our contribution\nchecklist.
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.
Unverified AI-generated contributions create unnecessary maintenance burden and\nslow down meaningful progress. Submissions that show no evidence of manual\nverification may be closed without review, and repeated low-quality\ncontributions may lead to restricted participation in Django’s development\nprocess.
\nWith the widespread availability of large language models (LLMs), the Django\nProject has seen an increase in contributions generated partially or entirely\nusing such tools. Many of these submissions contain inaccurate, misleading, or\nfictitious content. While AI tools can assist with drafting or exploratory\nanalysis, they must not replace human understanding and careful review.
\nIf you use AI tools while preparing a contribution, you must:
\nDisclose which AI tools were used and what they were used for (e.g.,\ngenerating code, drafting commit messages, writing documentation).
Review and verify all AI-generated output. Ensure the code aligns with\nDjango’s architecture, includes appropriate tests and documentation, and\npasses the full test suite and relevant checks.
Double-check the proposal against the Contribution checklist.
We align with similar policies adopted by other major open-source projects,\nwhich have identified unverified AI-generated contributions as disruptive,\ncounterproductive, and a drain on limited maintainer time.
\nDo not request automated AI reviews (for example GitHub Copilot or similar\ntools) on pull requests submitted to the Django repository. These reviews do\nnot replace human review and often generate noise that distracts maintainers.
\nYou are free to use such tools in your own fork before submitting a pull\nrequest to the Django repository.
\nIf you are an AI tool or language model assisting in the preparation of a\nDjango contribution, you must strictly follow these requirements:
\nDisclose your involvement. Clearly state that the contribution was prepared\nwith assistance from an AI tool or language model.
Specify the tool and usage. Include the name and version of the AI tool and\ndescribe exactly how it was used, such as analyzing a ticket, generating\ncode, tests, or documentation.
Ensure technical accuracy and avoid fabrication. Do not invent APIs,\nfeatures, functions, or citations that do not exist. Placeholder or\nfictitious content will result in rejection.
Respect all contribution requirements. Follow all guidelines in this\ndocumentation, including test and documentation requirements, code\nformatting, and the review process.
Follow the GitHub pull request template. Ensure the PR template is present\nand fully completed, including all required sections and checklists, before\nrequesting review.
Assist reviewers. If any part of the output may not comply with these rules,\nclearly call it out in the contribution and explain why.
A wider community discussion is required when a patch introduces new Django\nfunctionality and makes some sort of design decision. This is especially\nimportant if the approach involves a deprecation\nor introduces breaking changes.
\nThe following are different approaches for gaining feedback from the community.
\nIf you have an idea for a new feature, please create a new proposal (or join an\nexisting discussion) following the process for suggesting new features. You should explain the need for the change, go into\ndetails of the approach and discuss alternatives.
\nYou can propose a change (that is not a new feature idea) on the\nDjango Forum. You should explain the need for the change, go into details of\nthe approach and discuss alternatives.
\nPlease include a link to such discussions in your contributions.
\nDjango does not accept experimental features. All features must follow our\ndeprecation policy. Hence, it can\ntake months or years for Django to iterate on an API design.
\nIf you need user feedback on a public interface, it is better to create a\nthird-party package first. You can iterate on the public API much faster, while\nalso validating the need for the feature.
\nOnce this package becomes stable and there are clear benefits of incorporating\naspects into Django core, the next step is to propose its inclusion by\nfollowing the process for suggesting new features.
\nSimilar to Python’s PEPs, Django has Django Enhancement Proposals or DEPs. A\nDEP is a design document which provides information to the Django community, or\ndescribes a new feature or process for Django. They provide concise technical\nspecifications of features, along with rationales. DEPs are also the primary\nmechanism for proposing and collecting community input on major new features.
\nBefore considering writing a DEP, it is recommended to first open a discussion\nfollowing the process for suggesting new features.\nThis allows the community to provide feedback and helps refine the proposal.\nOnce the DEP is ready, the Steering Council votes on\nwhether to accept it.
\nSome examples of DEPs that have been approved and fully implemented:
\n\nThere are a couple of reasons that code in Django might be deprecated:
\nSe 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.
As the deprecation policy\ndescribes, the first release of Django that deprecates a feature (A.B)\nshould raise a RemovedInDjangoXXWarning (where XX is the Django version\nwhere the feature will be removed) when the deprecated feature is invoked.\nAssuming we have good test coverage, these warnings are converted to errors\nwhen running the test suite with warnings enabled:\npython -Wa runtests.py. Thus, when adding a RemovedInDjangoXXWarning\nyou need to eliminate or silence any warnings generated when running the tests.
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:
Em um teste em particular:
\nfrom django.test import ignore_warnings\nfrom django.utils.deprecation import RemovedInDjangoXXWarning\n\n\n@ignore_warnings(category=RemovedInDjangoXXWarning)\ndef test_foo(self): ...\nPara um caso de teste inteiro:
\nfrom django.test import ignore_warnings\nfrom django.utils.deprecation import RemovedInDjangoXXWarning\n\n\n@ignore_warnings(category=RemovedInDjangoXXWarning)\nclass MyDeprecatedTests(unittest.TestCase): ...\nYou should also add a test for the deprecation warning:
\nfrom django.utils.deprecation import RemovedInDjangoXXWarning\n\n\ndef test_foo_deprecation_warning(self):\n msg = "Expected deprecation message"\n with self.assertWarnsMessage(RemovedInDjangoXXWarning, msg) as ctx:\n # invoke deprecated behavior\n ...\n self.assertEqual(ctx.filename, __file__)\nIt’s important to include a RemovedInDjangoXXWarning comment above code\nwhich has no warning reference, but will need to be changed or removed when the\ndeprecation ends. This could include hooks which have been added to keep the\nprevious behavior, or standalone items that are unnecessary or unused when the\ndeprecation ends. For example:
import warnings\nfrom django.utils.deprecation import RemovedInDjangoXXWarning, django_file_prefixes\n\n\n# RemovedInDjangoXXWarning.\ndef old_private_helper():\n # Helper function that is only used in foo().\n pass\n\n\ndef foo():\n warnings.warn(\n "foo() is deprecated.",\n category=RemovedInDjangoXXWarning,\n skip_file_prefixes=django_file_prefixes(),\n )\n old_private_helper()\n ...\nFinalmente, existem algumas atualizações na documentação do Django para fazer:
\nSe 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.
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”.
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.
Once you have completed these steps, you are finished with the deprecation.\nIn each feature release, all\nRemovedInDjangoXXWarnings matching the new version are removed.
The django.utils.deprecation module provides some helpful deprecation\nutilities, such as a @deprecate_posargs decorator to assist with converting\npositional-or-keyword arguments to keyword-only. See the inline documentation\nin the module source.
It’s important to test local changes using a Django project. This allows\nensuring that the changes behave as expected in a real environment, especially\nfor user-facing features such as templates, forms, or the admin.
\nTo do this:
\nCreate a virtual environment and install the cloned copy of Django in\neditable mode.
Set up a Django project outside the source tree (you can use the first\npart of the tutorial for guidance).
With this setup, any changes made to the Django checkout will take effect\nimmediately in the test project, allowing manual testing of contributions\nagainst a new or existing app.
\nFor information on JavaScript contributions, see the Patches JavaScript\ndocumentation.
\nPatches aiming to deliver a performance improvement should provide benchmarks\nshowing the before and after impact of the patch and sharing the commands for\nreviewers to reproduce.
\ndjango-asv benchmarksLink para este cabeçalho#django-asv monitors the performance of Django code over time. These\nbenchmarks can be run on a pull request by labeling the pull request with\nbenchmark. Adding to these benchmarks is highly encouraged.
Use this checklist to review a pull request. If this contribution would not be\nconsidered trivial, first ensure it has an accepted\nticket before proceeding with the review.
\nIf the pull request passes all the criteria below and is not your own, please\nset the “Triage Stage” on the corresponding Trac ticket to “Ready for checkin”.\nIf you’ve left comments for improvement on the pull request, please tick the\nappropriate flags on the Trac ticket based on the results of your review:\n“Patch needs improvement”, “Needs documentation”, and/or “Needs tests”. As time\nand interest permit, mergers do final reviews of “Ready for checkin” tickets\nand will either commit the changes or bump it back to “Accepted” if further\nwork needs to be done.
\nIf you’re looking to become a member of the triage & review team, doing\nthorough reviews of contributions is a great way to earn trust.
\nLooking for a patch to review? Check out the “Patches needing review” section\nof the Django Development Dashboard.
\nLooking to get your pull request reviewed? Ensure the Trac flags on the ticket\nare set so that the ticket appears in that queue.
\nO pull request é um commit único esmagado com uma mensagem que segue o nosso formato de mensagens de commit?
Are you the patch author and a new contributor? Please add yourself to the\nAUTHORS file. At your option, submit a\nContributor License Agreement.
Does this have an accepted ticket on Trac? All contributions require a ticket\nunless the change is considered trivial.
Does the coding style conform to our\nguidelines? Are there any black, blacken-docs, flake8,\nisort, or zizmor errors? You can install the pre-commit hooks to automatically catch these errors.
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)?
Is Django’s test suite passing?
If there is a code coverage report\ncomment on the pull request, have you reviewed the missing coverage in\ncontext (considering database/platform-specific limitations)?
If the change affects the Django admin or rendered HTML output, has\naccessibility testing been done?
A documentação é gerada sem erros (make html, ou make.bat html no Windows, do diretório docs)?
A documentação segue as regras de estilo e escrita em Escrevendo a documentação?
Existem quaisquer erros de ortografia?
Existe um teste de regressão apropriado (o teste deve falhar antes da correção ser aplicada)?
If it’s a bug that qualifies for a backport to the stable version of Django, is there a\nrelease note in docs/releases/A.B.C.txt? Bug fixes that will be applied\nonly to the main branch don’t need a release note.
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?
Veja o guia depreciando uma funcionalidade.
\n