Before reporting a bug on the ticket tracker consider these points:
\nCheck that someone hasn’t already filed the bug report by searching or\nrunning custom queries in the ticket tracker.
Don’t use the ticket system to ask support questions. Use the Django Forum\nor the Django Discord server for that.
Don’t reopen issues that have been marked “wontfix” without finding consensus\nto do so on the Django Forum.
Don’t reopen issues that have been marked “needsnewfeatureprocess” without\nshepherding an issue through the new feature ideas GitHub project.
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 Django Forum.
Well-written bug reports are incredibly 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:
\nDo read the FAQ to see if your issue might\nbe a well-known question.
Do ask on Django Forum or the Django Discord server first if\nyou’re not sure if what you’re seeing is a bug.
Do 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.
Don’t post to Django Forum only to announce that you have filed a\nbug report. All the tickets are mailed to another list, django-updates,\nwhich is tracked by developers and interested community members; we see them\nas they are filed.
To understand the lifecycle of your ticket once you have created it, refer to\nTriage workflow.
\nIf your bug impacts anything visual in nature, there are a few additional\nguidelines to follow:
\nInclude 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.
If the issue is difficult to show off using a still image, consider\ncapturing a brief screencast. If your software permits it, capture only\nthe relevant area of the screen.
If you’re offering a patch that changes the look or behavior of Django’s\nUI, you must attach before and after screenshots/screencasts.\nTickets lacking these are difficult for triagers to assess quickly.
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.
Make sure to set the UI/UX flag on the ticket so interested parties can\nfind your ticket.
If the issue relates to accessibility, please link to the relevant\naccessibility standard if applicable.
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:
\nEvaluate 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.
Propose the feature in the new feature ideas GitHub project (not in the\nticket tracker) by creating a new item in the Idea column. This is where\nthe community and the Steering Council 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.
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.
Explain why 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.
See also: Documenting new features.
\nReports of a performance regression, or suggested performance optimizations,\nshould provide benchmarks and commands for the ticket triager to reproduce.
\nSee the django-asv benchmarks for more details of Django’s existing\nbenchmarks.
\nWhenever possible, we aim for rough consensus. Emoji reactions are used on\nissues within the new feature ideas GitHub project to track community\nfeedback. The following meanings are assigned to each reaction:
\n👍: I support this feature and would use it
👎: I oppose this feature or believe it would cause issues for me or Django
😕: I have no strong opinion on this feature
🎉: This feature seems like a straightforward and beneficial addition
The Steering Council will regularly review the ideas\nin the project, moving those with community support through the following\nstages:
\nIdea
Approved - Idea refinement - Team creation
In progress
Working solution - Review - Feedback
Needs maintainer (Django only)
Done
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:
\n+1: “I love the idea and I’m strongly committed to it.”
+0: “Sounds OK to me.”
-0: “I’m not thrilled, but I won’t stand in the way.”
-1: “I strongly disagree and would be very unhappy to see the idea turn\ninto reality.”
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.
\nTesting pre-releases is a great way to contribute to Django. Early testers\nhelp catch bugs before the final release, ensuring a smoother upgrade\nexperience for everyone.
\nBefore testing a pre-release, it is important that your project is running\nsmoothly on the latest stable release of Django. That way, any regressions can\nbe attributed to the pre-release. See the How to upgrade Django to a newer version guide\nfor instructions on getting up to date.
\nTo ensure your project is ready, you should also:
\nRead the release notes: Review the Release notes for the\nupcoming version to learn about upgrade paths for deprecated features or\nabout minor backward-incompatible changes.
Resolve deprecation warnings: Run your tests with deprecation warnings\nenabled to become aware of required follow-up actions:
\n$ python -Wa manage.py test\nYou can install the latest pre-release using pip:
$ python -m pip install --pre Django\nOnce installed, run your project’s test suite. Rather than just checking\nif tests pass, try the following:
\nCheck dependency support: Determine whether major dependencies support\nthe new version by checking Django version classifiers on PyPI.\nSince those projects also value early bug reports, don’t let a lack\nof support prevent you from testing.
Monitor performance: You can run your tests with the test\n--durations flag to identify potential performance regressions.
Automate tests in CI: Consider running your Continuous Integration (CI)\npipeline with the pre-release version.
Test manually: While automated tests are great, manually testing your\napplication’s main workflows is an important part of verifying compatibility\nwith a new release.
If you discover a bug, please report it via the Django issue tracker so it can be fixed before the final\nrelease. When creating the ticket, be sure to set the Django version field to\nthe exact pre-release version you are testing.
\nIf you suspect a regression, it’s helpful to report the specific commit that\ncaused it. See Bisecting a regression for instructions.
\nYou can also discuss any issues or share feedback in the Pre-releases category\non the Django Forum.
\n