{"title":"Reporting bugs and requesting features","version":"5.2","locale":"en","docname":"internals/contributing/bugs-and-features","url":"/en/5.2/internals/contributing/bugs-and-features/","canonical":"https://djangodocs.dev/en/5.2/internals/contributing/bugs-and-features/","summary":"Important Please report security issues only to security @ djangoproject . com . This is a private list only open to long-time, highly trusted Django developers,…","html":"<h1>Reporting bugs and requesting features<a class=\"heading-anchor\" href=\"#reporting-bugs-and-requesting-features\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<aside class=\"admonition admonition-important\">\n<p class=\"admonition-title\">Important</p>\n<p>Please report security issues <strong>only</strong> to\n<a class=\"reference external\" href=\"mailto:security&#37;&#52;&#48;djangoproject&#46;com\">security<span>&#64;</span>djangoproject<span>&#46;</span>com</a>.  This is a private list only open to\nlong-time, highly trusted Django developers, and its archives are\nnot public. For further details, please see <a class=\"reference internal\" href=\"/en/5.2/internals/security/\"><span class=\"doc\">our security\npolicies</span></a>.</p>\n</aside>\n<section id=\"reporting-bugs\">\n<span id=\"id1\"></span><h2>Reporting bugs<a class=\"heading-anchor\" href=\"#reporting-bugs\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Before reporting a bug on the <a class=\"reference external\" href=\"https://code.djangoproject.com/\">ticket tracker</a> consider these points:</p>\n<ul class=\"simple\">\n<li><p>Check that someone hasn’t already filed the bug report by <a class=\"reference external\" href=\"https://code.djangoproject.com/search\">searching</a> or\nrunning <a class=\"reference external\" href=\"https://code.djangoproject.com/query\">custom queries</a> in the ticket tracker.</p></li>\n<li><p>Don’t use the ticket system to ask support questions. Use the <a class=\"reference external\" href=\"https://forum.djangoproject.com/\">Django Forum</a>\nor the <a class=\"reference external\" href=\"https://chat.djangoproject.com\">Django Discord server</a> for that.</p></li>\n<li><p>Don’t reopen issues that have been marked “wontfix” without finding consensus\nto do so on the <a class=\"reference external\" href=\"https://forum.djangoproject.com/\">Django Forum</a>.</p></li>\n<li><p>Don’t use the ticket tracker for lengthy discussions, because they’re\nlikely to get lost. If a particular ticket is controversial, please move the\ndiscussion to the <a class=\"reference external\" href=\"https://forum.djangoproject.com/\">Django Forum</a>.</p></li>\n</ul>\n<p>Well-written bug reports are <em>incredibly</em> helpful. However, there’s a certain\namount of overhead involved in working with any bug tracking system so your\nhelp in keeping our ticket tracker as useful as possible is appreciated. In\nparticular:</p>\n<ul class=\"simple\">\n<li><p><strong>Do</strong> read the <a class=\"reference internal\" href=\"/en/5.2/faq/\"><span class=\"doc\">FAQ</span></a> to see if your issue might\nbe a well-known question.</p></li>\n<li><p><strong>Do</strong> ask on <a class=\"reference external\" href=\"https://forum.djangoproject.com/\">Django Forum</a> or the <a class=\"reference external\" href=\"https://chat.djangoproject.com\">Django Discord server</a> <em>first</em> if\nyou’re not sure if what you’re seeing is a bug.</p></li>\n<li><p><strong>Do</strong> write complete, reproducible, specific bug reports. You must\ninclude a clear, concise description of the problem, and a set of\ninstructions for replicating it. Add as much debug information as you can:\ncode snippets, test cases, exception backtraces, screenshots, etc. A nice\nsmall test case is the best way to report a bug, as it gives us a\nhelpful way to confirm the bug quickly.</p></li>\n<li><p><strong>Don’t</strong> post to <a class=\"reference external\" href=\"https://forum.djangoproject.com/\">Django Forum</a> only to announce that you have filed a\nbug report. All the tickets are mailed to another list, <a class=\"reference internal\" href=\"/en/5.2/internals/mailing-lists/#django-updates-mailing-list\"><span class=\"std std-ref\">django-updates</span></a>,\nwhich is tracked by developers and interested community members; we see them\nas they are filed.</p></li>\n</ul>\n<p>To understand the lifecycle of your ticket once you have created it, refer to\n<a class=\"reference internal\" href=\"/en/5.2/internals/contributing/triaging-tickets/\"><span class=\"doc\">Triaging tickets</span></a>.</p>\n<section id=\"reporting-user-interface-bugs\">\n<h3>Reporting user interface bugs<a class=\"heading-anchor\" href=\"#reporting-user-interface-bugs\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>If your bug impacts anything visual in nature, there are a few additional\nguidelines to follow:</p>\n<ul class=\"simple\">\n<li><p>Include screenshots in your ticket which are the visual equivalent of a\nminimal test case. Show off the issue, not the crazy customizations\nyou’ve made to your browser.</p></li>\n<li><p>If the issue is difficult to show off using a still image, consider\ncapturing a <em>brief</em> screencast. If your software permits it, capture only\nthe relevant area of the screen.</p></li>\n<li><p>If you’re offering a patch that changes the look or behavior of Django’s\nUI, you <strong>must</strong> attach before <em>and</em> after screenshots/screencasts.\nTickets lacking these are difficult for triagers to assess quickly.</p></li>\n<li><p>Screenshots don’t absolve you of other good reporting practices. Make sure\nto include URLs, code snippets, and step-by-step instructions on how to\nreproduce the behavior visible in the screenshots.</p></li>\n<li><p>Make sure to set the UI/UX flag on the ticket so interested parties can\nfind your ticket.</p></li>\n<li><p>If the issue relates to accessibility, please link to the relevant\n<a class=\"reference internal\" href=\"/en/5.2/internals/contributing/accessibility/#accessibility-standards\"><span class=\"std std-ref\">accessibility standard</span></a> if applicable.</p></li>\n</ul>\n</section>\n</section>\n<section id=\"requesting-features\">\n<span id=\"id2\"></span><h2>Requesting features<a class=\"heading-anchor\" href=\"#requesting-features\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>We’re always trying to make Django better, and your feature requests are a key\npart of that. Here are some tips on how to make a request most effectively:</p>\n<ul class=\"simple\">\n<li><p>Evaluate whether the feature idea requires changes in Django’s core. If your\nidea can be developed as an independent application or module — for\ninstance, you want to support another database engine — we’ll probably\nsuggest that you develop it independently. Then, if your project gathers\nsufficient community support, we may consider it for inclusion in Django.</p></li>\n<li><p>Propose the feature in the <a class=\"reference external\" href=\"https://github.com/orgs/django/projects/24/\">new feature ideas</a> GitHub project (not in the\nticket tracker) by creating a new item in the <strong>Idea</strong> column. This is where\nthe community and the <a class=\"reference internal\" href=\"/en/5.2/internals/organization/#steering-council\"><span class=\"std std-ref\">Steering Council</span></a> evaluate new\nideas for the Django ecosystem. This step is especially important for large\nor complex proposals. We prefer to discuss any significant changes to\nDjango’s core before any development begins. In some cases, a feature may be\nbetter suited as a third-party package, where it can evolve independently of\nDjango’s release cycle.</p></li>\n<li><p>Describe clearly and concisely what the missing feature is and how you’d\nlike to see it implemented. Include example code (non-functional is OK)\nif possible.</p></li>\n<li><p>Explain <em>why</em> you’d like the feature. Explaining a minimal use case will help\nothers understand where it fits in, and if there are already other ways of\nachieving the same thing.</p></li>\n</ul>\n<p>See also: <a class=\"reference internal\" href=\"/en/5.2/internals/contributing/writing-documentation/#documenting-new-features\"><span class=\"std std-ref\">Documenting new features</span></a>.</p>\n</section>\n<section id=\"requesting-performance-optimizations\">\n<h2>Requesting performance optimizations<a class=\"heading-anchor\" href=\"#requesting-performance-optimizations\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Reports of a performance regression, or suggested performance optimizations,\nshould provide benchmarks and commands for the ticket triager to reproduce.</p>\n<p>See the <a class=\"reference internal\" href=\"/en/5.2/internals/contributing/writing-code/submitting-patches/#django-asv-benchmarks\"><span class=\"std std-ref\">django-asv benchmarks</span></a> for more details of Django’s existing\nbenchmarks.</p>\n</section>\n<section id=\"how-we-make-decisions\">\n<span id=\"id3\"></span><h2>How we make decisions<a class=\"heading-anchor\" href=\"#how-we-make-decisions\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Whenever possible, we aim for rough consensus. Emoji reactions are used on\nissues within the <a class=\"reference external\" href=\"https://github.com/orgs/django/projects/24/\">new feature ideas</a> GitHub project to track community\nfeedback. The following meanings are assigned to each reaction:</p>\n<ul class=\"simple\">\n<li><p>👍: I support this feature and would use it</p></li>\n<li><p>👎: I oppose this feature or believe it would cause issues for me or Django</p></li>\n<li><p>😕: I have no strong opinion on this feature</p></li>\n<li><p>🎉: This feature seems like a straightforward and beneficial addition</p></li>\n</ul>\n<p>The <a class=\"reference internal\" href=\"/en/5.2/internals/organization/#steering-council\"><span class=\"std std-ref\">Steering Council</span></a> will regularly review the ideas\nin the project, moving those with community support through the following\nstages:</p>\n<ul class=\"simple\">\n<li><p>Idea</p></li>\n<li><p>Approved - Idea refinement - Team creation</p></li>\n<li><p>In progress</p></li>\n<li><p>Working solution - Review - Feedback</p></li>\n<li><p>Needs maintainer (Django only)</p></li>\n<li><p>Done</p></li>\n</ul>\n<p>Occasionally, discussions on feature ideas or the direction of Django may take\nplace on the Django Forum. These discussions may include informal votes, which\nfollow the voting style invented by Apache and used on Python itself, where\nvotes are given as +1, +0, -0, or -1.\nRoughly translated, these votes mean:</p>\n<ul class=\"simple\">\n<li><p>+1: “I love the idea and I’m strongly committed to it.”</p></li>\n<li><p>+0: “Sounds OK to me.”</p></li>\n<li><p>-0: “I’m not thrilled, but I won’t stand in the way.”</p></li>\n<li><p>-1: “I strongly disagree and would be very unhappy to see the idea turn\ninto reality.”</p></li>\n</ul>\n<p>Although these votes are informal, they’ll be taken very seriously. After a\nsuitable voting period, if an obvious consensus arises we’ll follow the votes.</p>\n</section>","rootId":"reporting-bugs-and-requesting-features","toc":[{"title":"Reporting bugs","anchor":"reporting-bugs","children":[{"title":"Reporting user interface bugs","anchor":"reporting-user-interface-bugs","children":[]}]},{"title":"Requesting features","anchor":"requesting-features","children":[]},{"title":"Requesting performance optimizations","anchor":"requesting-performance-optimizations","children":[]},{"title":"How we make decisions","anchor":"how-we-make-decisions","children":[]}],"breadcrumbs":[{"docname":"internals/index","title":"Django internals","url":"/en/5.2/internals/"},{"docname":"internals/contributing/index","title":"Contributing to Django","url":"/en/5.2/internals/contributing/"}],"prev":{"docname":"internals/contributing/localizing","title":"Localizing Django","url":"/en/5.2/internals/contributing/localizing/"},"next":{"docname":"internals/contributing/triaging-tickets","title":"Triaging tickets","url":"/en/5.2/internals/contributing/triaging-tickets/"},"formats":{"html":"/en/5.2/internals/contributing/bugs-and-features/","markdown":"/en/5.2/internals/contributing/bugs-and-features.md","json":"/en/5.2/internals/contributing/bugs-and-features.json"},"source":"https://github.com/django/django/blob/stable/5.2.x/docs/internals/contributing/bugs-and-features.txt","official":"https://docs.djangoproject.com/en/5.2/internals/contributing/bugs-and-features/","inVersions":["dev","6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9","1.8"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}