summaryrefslogtreecommitdiff
path: root/docs/internals
AgeCommit message (Collapse)Author
2025-12-22Fixed #36305 -- Added documentation indentation guidelines to contributing docs.ankan0503
2025-12-11Fixed #36789 -- Added missing PDF file for ↵Pravin Kamble
docs/internals/_images/contribution_process.svg. The PDF is needed to build the PDF version of the whole docs.
2025-12-08Fixed #36778 -- Extended advice to sanitize input before using in query ↵Jacob Walls
expressions. Thanks Clifford Gama and Simon Charette for reviews.
2025-12-07Refs #36620 -- Added contributor documentation for code coverage reports.saurabh
This was included in the original reverted patch: a89183e63844a937aacd3ddb73c4952ef869d2cc Follow-up to 26b0e2bb92caf2d16cabe455792350f20d6f42ca.
2025-11-26Included usage of new scripts in docs/internals/howto-release-django.txt.Natalia
2025-11-25Reverted "Fixed #36620 -- Added coverage workflow to summarize coverage in ↵Natalia
pull requests." This reverts commit a89183e63844a937aacd3ddb73c4952ef869d2cc.
2025-11-22Removed outdated build guidance in release docs.Jacob Walls
Follow-up to 4686541691dbe986f58ac87630c3b7a04db4ff93.
2025-11-21Fixed #36620 -- Added coverage workflow to summarize coverage in pull requests.saurabh
Part of GSoC 2025. Thanks Lily for mentorship, and Sarah Boyce and Jacob Walls for reviews.
2025-11-21Added GitHub Actions linter (zizmor).Jacob Walls
At the direction of the Security Team. Thanks Markus Holtermann, Jake Howard, and Natalia Bidart for reviews.
2025-11-04Updated ticket triage process diagram and contributing docs.ontowhee
2025-10-19Refs #36005 -- Bumped minimum supported versions of docutils to 0.22.Mariusz Felisiak
2025-10-16Bumped minimum isort version to 7.0.0.Jacob Walls
Added ignores relating to https://github.com/PyCQA/isort/issues/2352.
2025-10-14Removed pre-release wheel-only advice in ↵Jacob Walls
docs/internals/howto-release-django.txt. The practice since 2.2a1 (2019) has been to upload source distributions as well.
2025-10-14Removed mention of setuptools in ↵Jacob Walls
docs/internals/contributing/writing-code/unit-tests.txt.
2025-10-13Cautioned against multi-level relative imports in coding style docs.lyova24
2025-10-13Added notes about automatic roadmap generation for next version in ↵Natalia
docs/internals/howto-release-django.txt.
2025-09-30Fixed #36614 -- Deprecated QuerySet.values_list(flat=True) without a field.Adam Johnson
Thanks to Jacob Walls and Simon Charette for their input. co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
2025-09-18Clarified feature freeze and alpha release steps in ↵Natalia
docs/internals/howto-release-django.txt.
2025-09-17Added backticks to email addresses in docs.Mariusz Felisiak
2025-09-17Advanced deprecation warnings for Django 6.1.Jacob Walls
2025-09-13Refs #35667 -- Corrected usage of skip_file_prefixes in contributing docs.Clifford Gama
2025-09-12Refs #35667 -- Updated contributing guide to use django_file_prefixes on ↵nessita
deprecations.
2025-08-28Ensured :doc: role uses absolute targets in docs.Adam Johnson
2025-08-28Replaced :doc: role usage with :ref: when appropriate in docs.Natalia
2025-08-28Fixed #36570 -- Removed unnecessary :py domain from documentation roles.SaJH
Signed-off-by: SaJH <wogur981208@gmail.com>
2025-08-27Fixed #36572 -- Revert "Fixed #36546 -- Deprecated ↵Sarah Boyce
django.utils.crypto.constant_time_compare() in favor of hmac.compare_digest()." This reverts commit 0246f478882c26bc1fe293224653074cd46a90d0.
2025-08-26Clarified Trac "version" attribute in contributing guide.Jacob Walls
2025-08-26Corrected definition of "needsinfo" triage stage in contributing guide.Jacob Walls
2025-08-25Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.David Smith
The `check` docs target now runs spelling, black, and lint, so all current documentation quality checks can be run with a single command. Also documented the lint-docs check's availability and usage.
2025-08-25Refs #36485 -- Rewrapped docs to 79 columns line length.David Smith
Lines in the docs files were manually adjusted to conform to the 79 columns limit per line (plus newline), improving readability and consistency across the content.
2025-08-25Refs #36485 -- Removed double spaces after periods in sentences.Natalia
2025-08-25Refs #36485 -- Fixed dangling hyphen and unbalanced inline markup in docs.David Smith
2025-08-25Refs #36485 -- Removed unnecessary parentheses in :meth: and :func: roles in ↵David Smith
docs.
2025-08-25Fixed #36546 -- Deprecated django.utils.crypto.constant_time_compare() in ↵SaJH
favor of hmac.compare_digest(). Signed-off-by: SaJH <wogur981208@gmail.com>
2025-08-23Removed reference to flake8 file exclusions.Jacob Walls
Obsolete since 41384812efe209c8295a50d78b45e0ffb2992436. (six was removed in 9285926295fbfc86b70e7be8d595d4cfbe7895b8.)
2025-08-22Refs #35530 -- Corrected deprecation message in auth.alogin().Mariusz Felisiak
Follow up to ceecd518b19044181a3598c55ebed7c2545963cc.
2025-08-05Refs #36485 -- Grouped docs checks under a unified make check target.David Smith
Added a new 'check' rule to the docs Makefile which runs both the black and spelling checks.
2025-08-05Refs #34140 -- Added dedicated code block formatting section in ↵David Smith
docs/internals/contributing/writing-documentation.txt.
2025-07-28Moved manual testing instructions from intro to submitting patches docs.Jordan Bae
The section on manual testing, including how to use a local checkout of Django, is moved from the contribution intro to the submitting patches docs. This makes it easier for reviewers and authors to follow best practices.
2025-07-25Fixed #35581 -- Updated django.core.mail to Python's modern email API.Mike Edmunds
- Changed EmailMessage.message() to construct a "modern email API" email.message.EmailMessage and added policy keyword arg. - Added support for modern MIMEPart objects in EmailMessage.attach() (and EmailMessage constructor, EmailMessage.attachments list). - Updated SMTP EmailBackend to use modern email.policy.SMTP. Deprecated: - Attaching MIMEBase objects (replace with MIMEPart) - BadHeaderError (modern email uses ValueError) - SafeMIMEText, SafeMIMEMultipart (unnecessary for modern email) - django.core.mail.forbid_multi_line_headers() (undocumented, but exposed via `__all__` and in wide use) - django.core.mail.message.sanitize_address() (undocumented, but in wide use) Removed without deprecation (all undocumented): - EmailMessage.mixed_subtype - EmailMultiAlternatives.alternative_subtype - Support for setting (undocumented) EmailMessage.encoding property to a legacy email.charset.Charset object Related changes: - Dropped tests for incorrect RFC 2047 encoding of non-ASCII email address localparts. This is specifically prohibited by RFC 2047, and not supported by any known MTA or email client. (Python still mis-applies encoded-word to non-ASCII localparts, but it is a bug that may be fixed in the future.) - Added tests that try to discourage using Python's legacy email APIs in future updates to django.core.mail.
2025-07-23Fixed #36500 -- Set flake8 max-doc-length config to 79 columns.Mike Edmunds
Set flake8 max-doc-length to 79 to enforce smaller line length limit on docstrings and comments (per coding-style docs). Updated docs to clarify both requirements are enforced by flake8 and to remove some leftover language from the pre-black era.
2025-07-23Added accessibility guidelines for contributors.Thibaud Colas
2025-07-17Fixed #36163 -- Deprecated most positional arguments in django.core.mail.Mike Edmunds
In public mail APIs, changed less frequently used parameters from keyword-or-positional to keyword-only, emitting a warning during the required deprecation period.
2025-07-16Fixed #36477, Refs #36163 -- Added @deprecate_posargs decorator to simplify ↵Mike Edmunds
deprecation of positional arguments. This helper allows marking positional-or-keyword parameters as keyword-only with a deprecation period, in a consistent and correct manner.
2025-07-13Added Django ecosystem page to the documentation.Tim Schilling
2025-07-09Updated asgiref dependency.Carlton Gibson
2025-06-27Fixed indentation in docs/internals/howto-release-django.txt.Sarah Boyce
2025-06-27Separated creating the release and setting it as default in Trac in the ↵Sarah Boyce
post-release steps.
2025-06-20Fixed #36152 -- Deprecated use of "%" in column aliases.Jacob Walls
Unintentional support existed only on SQLite and Oracle.
2025-06-18Clarified that only latest dependency versions are valid for security reports.Jake Howard