1
0
mirror of https://github.com/django/django.git synced 2025-08-21 09:19:12 +00:00

425 Commits

Author SHA1 Message Date
David Smith
7f9bf357fe Refs #36485 -- Grouped docs checks under a unified make check target.
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.
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
3ad0e759a6 Fixed #36500 -- Set flake8 max-doc-length config to 79 columns.
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. 2025-07-23 16:40:51 +02: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. 2025-07-13 14:09:47 +02:00
Carlton Gibson
a8912e4383
Updated asgiref dependency. 2025-07-09 18:06:49 +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
Aarni Koskela
6b32506739 Fixes #36215 -- Included unpacking generalization notes in coding style guide (PEP-448). 2025-03-31 22:43:13 -03:00
Mike Edmunds
e295033144 Fixed #36138 -- Changed ADMINS and MANAGERS settings to lists of strings.
Previously, the ADMINS and MANAGERS settings were lists of (name, address)
tuples (where the name had been unused). Deprecated use of tuples.

Updated settings value sanity checks, and changed from ValueError to
ImproperlyConfigured.
2025-03-21 10:17:57 +01:00
Sarah Boyce
86493307f9 Fixed #35908 -- Retired the django-developers and django-users mailing lists.
Co-authored-by: Chaitanya Rahalkar <chaitanyarahalkar@squareup.com>
2025-02-19 12:14:27 +01:00
Mariusz Felisiak
d9af197801
Refs #36005 -- Bumped minimum supported versions of 3rd-party packages.
This bumps minimum supported versions of 3rd-party packages to the first
releases to support Python 3.12.
2025-01-28 08:02:13 +01:00
Baptiste Mispelon
9a1f18635f
Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server. 2025-01-22 18:22:50 -03:00
Mariusz Felisiak
337c641abb
Refs #32193 -- Updated python-memcached to pymemcache in contributing guide.
Follow up to 05f3a6186efefc9fca2204a745b992501c6fd91f.
2025-01-20 22:43:44 +01:00
Mariusz Felisiak
f5772de696 Fixed #36005 -- Dropped support for Python 3.10 and 3.11. 2025-01-20 14:07:28 +01:00
Sarah Boyce
810edfd742 Removed versionadded/changed annotations for 5.1.
This also removes remaining versionadded/changed annotations for older
versions.
2025-01-15 22:28:37 +01:00
Sarah Boyce
15e207ce80 Fixed #35999 -- Removed #django IRC channel references where appropriate.
Some references are replaced with links to the Django Discord server.
2025-01-08 10:24:52 +01:00
Adam Zapletal
e9ed5da3cb
Removed trailing whitespace in docs. 2024-11-27 13:13:28 -03:00
AfiMaameDufie
da2432ccca Replaced message suggestions from IRC to Discord in contributing docs. 2024-11-14 11:36:16 +01:00
Mariusz Felisiak
46eb256cce Refs #32365 -- Removed pytz from list of test dependencies in unit test docs.
Follow up to e6f82438d4e3750e8d299bfd79dac98eebe9f1e0.
2024-11-11 12:24:21 +01:00
ssanger
c4c076223e Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs.
This improves accessibility for screen reader users, see WCAG SC 1.3.1 Info and Relationships:
https://www.w3.org/WAI/WCAG22/Understanding/info-and-relationships.html
2024-11-06 17:03:21 +01:00
Maria Hynes
db5980ddd1 Clarified instructions on how to claim a ticket. 2024-11-05 16:59:34 +01:00
maddrum
b50d1a020d Fixed #35866 -- Clarified the positioning Python magic methods on models in the internal style guide. 2024-10-30 16:21:57 +01:00
Paolo Melchiorre
b5669f08bc Improved the writing documentation contributing guide. 2024-10-25 16:35:35 +02:00
mbcodes
c973d9ee82 Improved readability of triage workflow image by increasing its size and color contrast. 2024-10-25 10:00:33 +02:00
Maryam Yusuf
438fc42ac6 Expanded contributor docs on getting feedback from the wider community. 2024-10-16 13:23:19 +02:00
Simon Charette
57307bbc7d Fixed #35666 -- Documented stacklevel usage and testing, and adjusted test suite accordingly.
Over the years we've had multiple instances of hit and misses when
emitting warnings: either setting the wrong stacklevel or not setting
it at all.

This work adds assertions for the existing warnings that were declaring
the correct stacklevel, but were lacking tests for it.
2024-08-28 11:44:05 -03:00
Mariusz Felisiak
304d256674
Used :pypi: role in docs where appropriate. 2024-08-05 10:35:50 -03:00
Maryam Yusuf
7e00fee3bd Fixed #35546 -- Emphasised accepted ticket requirement in contributing docs. 2024-07-29 15:12:43 +02:00
Maryam Yusuf
9d10c7ab33 Referenced joining the triage and review team as motivation to do PR reviews. 2024-07-29 14:46:10 +02:00
Sarah Boyce
2c024c9ac0 Added contributor guidelines for performance optimizations. 2024-07-25 09:25:25 +02:00
Mariusz Felisiak
df35cf578f Updated asgiref dependency for 5.1 release series. 2024-07-24 08:21:07 +02:00
Andreu Vallbona
55a2e3136b Replaced usage of "patch" with more precise terms in contributing docs. 2024-07-04 17:52:19 -03:00
Claude Paroz
4686541691
Migrated setuptools configuration to pyproject.toml.
This branch migrates setuptools configuration from setup.py/setup.cfg to
pyproject.toml. In order to ensure that the generated binary files have
consistent casing (both the tarball and the wheel), setuptools version
is limited to ">=61.0.0,<69.3.0".

Configuration for flake8 was moved to a dedicated .flake8 file since
it cannot be configured via pyproject.toml.

Also, __pycache__ exclusion was removed from MANIFEST and the
extras/Makefile was replaced with a simpler build command.

Co-authored-by: Nick Pope <nick@nickpope.me.uk>
2024-06-24 15:34:43 -03:00
Sarah Boyce
39828fa778 Added a high contrast mode to screenshot cases.
Thank you to Sarah Abderemane and Nick Pope for the reviews.
2024-05-02 13:18:58 +02:00
Ryan Cheley
f2c3524959 Fixed #14831 -- Extended template style guide in docs. 2024-03-11 11:05:54 +01:00
Mariusz Felisiak
177e649396
Fixed broken links and redirects in docs. 2024-03-06 08:50:21 +01:00
Koo
aaffbabd58
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2024-02-08 05:57:59 +01:00
Mariusz Felisiak
305757aec1
Applied Black's 2024 stable style.
https://github.com/psf/black/releases/tag/24.1.0
2024-01-26 12:45:07 +01:00
Mark Walker
4eb4ab4122 Reorganized the Contributing to Django docs.
This work follows a comprehensive review conducted during the DjangoCon US 2023
sprints. Changes include:
 - Updated the title of the main page for better alignment with the content.
 - Removed emojis to enhance accessibility and avoid cultural specificity.
 - Improved the layout and navigation of contributing documentation.
 - Unified sections for communication channels and community links.
 - Grouped resources according to the Diátaxis systematic approach.

Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
Co-authored-by: Daniele Procida <daniele@vurt.org>
2024-01-11 22:25:27 -03:00
Mark Walker
6ab0f8ae52 Improved structure of Contributing Guide start page. 2023-11-30 08:33:29 +01:00
Lance Goyke
a680ac7d77 Restructured writing documentation contributing guide.
This trims and clearly delineates the how to guide from the subsequent
explanation with additional subheadings.

These changes have been discussed with Daniele Procida
at the DjangoCon US 2023 sprints.
2023-10-21 09:44:36 +02:00
David Smith
1611577102 Corrected note about using accents in writing documentation contributing guide. 2023-10-21 09:39:16 +02:00
Sarah Boyce
be56c982c0 Refs #34043 -- Added --screenshots option to runtests.py and selenium tests. 2023-10-18 06:14:40 +02:00
sarahboyce
e083f3082c Refs #34043 -- Clarified how to test UI changes. 2023-10-09 10:45:29 +02:00
Mariusz Felisiak
295467c04a Removed versionadded/changed annotations for 4.2.
This also removes remaining versionadded/changed annotations for older
versions.
2023-09-18 22:12:40 +02:00
Jacob Walls
6c6606aa01 Refs #34233 -- Bumped minimum supported version of docutils to 0.19. 2023-09-04 22:30:45 +02:00
Sulabh Katila
9a9620dda6 Fixed #34768 -- Avoided initializing colorama on non-Windows platforms. 2023-09-01 11:26:29 +02:00
Nick Pope
500e01073a
Fixed #31262 -- Added support for mappings on model fields and ChoiceField's choices. 2023-08-30 22:57:40 -03:00