ontowhee
eaf7b563a5
Updated ticket triage process diagram and contributing docs.
2025-11-04 09:38:03 -03:00
Mariusz Felisiak
ca3e0484ef
Refs #36005 -- Bumped minimum supported versions of docutils to 0.22.
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.14 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
Docs / blacken-docs (push) Has been cancelled
Docs / spelling (push) Has been cancelled
Docs / lint-docs (push) Has been cancelled
2025-10-19 20:13:16 +02:00
Jacob Walls
d980d68609
Bumped minimum isort version to 7.0.0.
...
Docs / spelling (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Docs / lint-docs (push) Waiting to run
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
Added ignores relating to https://github.com/PyCQA/isort/issues/2352 .
2025-10-16 14:59:02 -04:00
Jacob Walls
cc9df52666
Removed pre-release wheel-only advice in docs/internals/howto-release-django.txt.
...
The practice since 2.2a1 (2019) has been to upload source distributions
as well.
2025-10-14 08:46:14 -04:00
Jacob Walls
1910115807
Removed mention of setuptools in docs/internals/contributing/writing-code/unit-tests.txt.
2025-10-14 08:41:32 -04:00
lyova24
a545eb0c1a
Cautioned against multi-level relative imports in coding style docs.
Docs / spelling (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Docs / lint-docs (push) Waiting to run
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
2025-10-13 17:27:07 -04:00
Natalia
d5543a23d3
Added notes about automatic roadmap generation for next version in docs/internals/howto-release-django.txt.
2025-10-13 17:41:30 -03:00
Adam Johnson
8b241f84e2
Fixed #36614 -- Deprecated QuerySet.values_list(flat=True) without a field.
...
Docs / spelling (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Docs / lint-docs (push) Waiting to run
Linters / flake8 (push) Has been cancelled
Linters / isort (push) Has been cancelled
Linters / black (push) Has been cancelled
Tests / Windows, SQLite, Python 3.13 (push) Has been cancelled
Tests / JavaScript tests (push) Has been cancelled
Thanks to Jacob Walls and Simon Charette for their input.
co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
2025-09-30 08:46:28 +02:00
Natalia
5ddb01c760
Clarified feature freeze and alpha release steps in docs/internals/howto-release-django.txt.
2025-09-18 22:07:06 -03:00
Mariusz Felisiak
f8d2610d94
Added backticks to email addresses in docs.
Docs / spelling (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Docs / lint-docs (push) Waiting to run
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
2025-09-17 22:23:57 +02:00
Jacob Walls
cebbd5a6ad
Advanced deprecation warnings for Django 6.1.
2025-09-17 15:17:05 -03:00
Clifford Gama
9932866e3a
Refs #35667 -- Corrected usage of skip_file_prefixes in contributing docs.
Docs / spelling (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Docs / lint-docs (push) Waiting to run
2025-09-13 08:20:17 -04:00
nessita
8956ee3ce3
Refs #35667 -- Updated contributing guide to use django_file_prefixes on deprecations.
2025-09-12 11:15:13 -05:00
Adam Johnson
56955636e6
Ensured :doc: role uses absolute targets in docs.
2025-08-28 13:48:32 -03:00
Natalia
ae03f81ffa
Replaced :doc: role usage with :ref: when appropriate in docs.
2025-08-28 13:48:32 -03:00
SaJH
3c0c54351b
Fixed #36570 -- Removed unnecessary :py domain from documentation roles.
...
Signed-off-by: SaJH <wogur981208@gmail.com>
2025-08-28 08:52:43 +02:00
Sarah Boyce
d0e4dd5cdd
Fixed #36572 -- Revert "Fixed #36546 -- Deprecated django.utils.crypto.constant_time_compare() in favor of hmac.compare_digest()."
...
Docs / spelling (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Docs / lint-docs (push) Waiting to run
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
This reverts commit 0246f47888 .
2025-08-27 10:50:50 +02:00
Jacob Walls
c594574175
Clarified Trac "version" attribute in contributing guide.
Docs / blacken-docs (push) Waiting to run
Docs / lint-docs (push) Waiting to run
Docs / spelling (push) Waiting to run
2025-08-26 17:49:06 -04:00
Jacob Walls
66082a7dac
Corrected definition of "needsinfo" triage stage in contributing guide.
2025-08-26 16:00:47 -04:00
David Smith
43e4d0a142
Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.
...
Docs / spelling (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Linters / flake8 (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
Docs / lint-docs (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
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-25 10:51:10 -03:00
David Smith
f81e6e3a53
Refs #36485 -- Rewrapped docs to 79 columns line length.
...
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-25 10:51:10 -03:00
Natalia
4286a23df6
Refs #36485 -- Removed double spaces after periods in sentences.
2025-08-25 10:51:10 -03:00
David Smith
724e5ec6f2
Refs #36485 -- Fixed dangling hyphen and unbalanced inline markup in docs.
2025-08-25 10:51:10 -03:00
David Smith
6f8e23d1c1
Refs #36485 -- Removed unnecessary parentheses in :meth: and :func: roles in docs.
2025-08-25 10:51:10 -03:00
SaJH
0246f47888
Fixed #36546 -- Deprecated django.utils.crypto.constant_time_compare() in favor of hmac.compare_digest().
...
Docs / blacken-docs (push) Waiting to run
Docs / spelling (push) Waiting to run
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
Signed-off-by: SaJH <wogur981208@gmail.com>
2025-08-25 14:45:16 +02:00
Jacob Walls
165ad74c57
Removed reference to flake8 file exclusions.
...
Linters / isort (push) Has been cancelled
Linters / black (push) Has been cancelled
Docs / blacken-docs (push) Has been cancelled
Linters / flake8 (push) Has been cancelled
Docs / spelling (push) Has been cancelled
Tests / Windows, SQLite, Python 3.13 (push) Has been cancelled
Tests / JavaScript tests (push) Has been cancelled
Obsolete since 41384812ef .
(six was removed in 9285926295 .)
2025-08-23 20:01:00 +02:00
Mariusz Felisiak
b3166e1e15
Refs #35530 -- Corrected deprecation message in auth.alogin().
...
Docs / spelling (push) Waiting to run
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
Follow up to ceecd518b1 .
2025-08-22 16:14:09 +02:00
David Smith
7f9bf357fe
Refs #36485 -- Grouped docs checks under a unified make check target.
...
Docs / docs (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Linters / flake8 (push) Has been cancelled
Linters / isort (push) Has been cancelled
Linters / black (push) Has been cancelled
Tests / Windows, SQLite, Python 3.13 (push) Has been cancelled
Tests / JavaScript tests (push) Has been cancelled
Added a new 'check' rule to the docs Makefile which runs both the black
and spelling checks.
2025-08-05 12:18:19 -03:00
David Smith
cba7328196
Refs #34140 -- Added dedicated code block formatting section in docs/internals/contributing/writing-documentation.txt.
2025-08-05 12:18:19 -03:00
Jordan Bae
fdeca38072
Moved manual testing instructions from intro to submitting patches docs.
...
Docs / docs (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
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-28 08:55:42 -03:00
Mike Edmunds
9ab1991689
Fixed #35581 -- Updated django.core.mail to Python's modern email API.
...
- 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-25 13:50:02 +02:00
Mike Edmunds
3ad0e759a6
Fixed #36500 -- Set flake8 max-doc-length config to 79 columns.
...
Tests / JavaScript tests (push) Waiting to run
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Docs / docs (push) Has been cancelled
Docs / blacken-docs (push) Has been cancelled
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-23 20:17:55 -03:00
Thibaud Colas
5527df9192
Added accessibility guidelines for contributors.
Docs / docs (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
2025-07-23 16:40:51 +02:00
Mike Edmunds
fc793fc303
Fixed #36163 -- Deprecated most positional arguments in django.core.mail.
...
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-17 14:01:16 -03:00
Mike Edmunds
f42b89f1bf
Fixed #36477 , Refs #36163 -- Added @deprecate_posargs decorator to simplify 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-16 08:49:03 -03:00
Tim Schilling
395e498553
Added Django ecosystem page to the documentation.
Docs / docs (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
2025-07-13 14:09:47 +02:00
Carlton Gibson
a8912e4383
Updated asgiref dependency.
2025-07-09 18:06:49 +02:00
Sarah Boyce
a388287692
Fixed indentation in docs/internals/howto-release-django.txt.
2025-06-27 09:46:17 -03:00
Sarah Boyce
af6ed55fcd
Separated creating the release and setting it as default in Trac in the post-release steps.
2025-06-27 09:46:17 -03:00
Jacob Walls
8ede411a81
Fixed #36152 -- Deprecated use of "%" in column aliases.
...
Docs / docs (push) Has been cancelled
Docs / blacken-docs (push) Has been cancelled
Linters / black (push) Waiting to run
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
Unintentional support existed only on SQLite and Oracle.
2025-06-20 08:25:22 +02:00
Jake Howard
bc1bfe12b6
Clarified that only latest dependency versions are valid for security reports.
Docs / docs (push) Has been cancelled
Docs / blacken-docs (push) Has been cancelled
2025-06-18 11:04:34 -03:00
nessita
0f60102444
Added guidance on AI-assisted security reports to docs/internals/security.txt.
...
Co-authored-by: Shai Berger <shai@platonix.com>
Co-authored-by: Mike Edmunds <medmunds@gmail.com>
2025-06-17 11:45:03 -03:00
Sarah Boyce
1704c49a9b
Fixed #36390 -- Deprecated RemoteUserMiddleware subclasses missing aprocess_request().
...
Regression in 50f89ae850 .
Thank you to shamoon for the report and Natalia Bidart for the review.
2025-05-23 10:22:36 +02:00
Lily Foote
188799e67c
Updated guidance to propose new feature ideas in contributing docs.
...
These changes include:
* Clarification of the new feature proposal and evaluation process.
* Reodering "points to consider" into reporting bugs section, since
these are mostly trac-specific.
* Narrowing the guide on user interface bugs and features to just bugs.
* Updating documentation for Someday/Maybe triage stage.
Co-authored-by: Tim Schilling <schilling711@gmail.com>
Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2025-05-13 21:38:04 -03:00
Natalia
f7d97dd118
Simplified artifact building steps in docs/internals/howto-release-django.txt.
...
With the recent merge of artifact build updates from
https://github.com/django/django/pull/19436 , there is no need to have
different build instructions for 4.2.
2025-05-06 11:11:40 -03:00
Ahmed Nassar
be402891cd
Fixed #36311 -- Unified spelling of "hardcode" and its variants in docs.
...
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2025-04-15 14:48:55 -03:00
Natalia
4a824b1313
Added usage for --since when fetching translations in docs/internals/howto-release-django.txt.
2025-04-04 15:55:07 -03:00
Aarni Koskela
6b32506739
Fixes #36215 -- Included unpacking generalization notes in coding style guide (PEP-448).
2025-03-31 22:43:13 -03:00
wookkl
334677ad57
Fixed #35452 -- Deprecated orphans being more than or equal to page_size in pagination.
2025-03-25 12:04:13 +01:00
Sarah Boyce
922c1c732a
Documented the updating of translation catalogs in post-release tasks.
...
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2025-03-21 14:54:29 +01:00