summaryrefslogtreecommitdiff
path: root/docs/internals/contributing
AgeCommit message (Collapse)Author
2025-11-21[6.0.x] Added GitHub Actions linter (zizmor).Jacob Walls
At the direction of the Security Team. Thanks Markus Holtermann, Jake Howard, and Natalia Bidart for reviews. Backport of 09d4bf5cd9c95c588d3ec22edea5db1f5f146900 from main.
2025-11-04[6.0.x] Updated ticket triage process diagram and contributing docs.ontowhee
Backport of eaf7b563a5d3861026242fdb503a58f71acf17f6 from main.
2025-10-19[6.0.x] Refs #36005 -- Bumped minimum supported versions of docutils to 0.22.Mariusz Felisiak
Backport of ca3e0484ef31d13053af6a9d50667813e22fc282 from main.
2025-10-16[6.0.x] Bumped minimum isort version to 7.0.0.Jacob Walls
Added ignores relating to https://github.com/PyCQA/isort/issues/2352. Backport of d980d68609448a4c85763fa34e471ff80540888b from main.
2025-10-14[6.0.x] Removed mention of setuptools in ↵Jacob Walls
docs/internals/contributing/writing-code/unit-tests.txt. Backport of 19101158070429c8d314926a67ec22a88220f316 from main.
2025-10-13[6.0.x] Cautioned against multi-level relative imports in coding style docs.lyova24
Backport of a545eb0c1ad5dcbb4e4cf22ce6cf486224c0ba8a from main.
2025-09-17[6.0.x] Added backticks to email addresses in docs.Mariusz Felisiak
Backport of f8d2610d94333a8b0fd283851a6cf4ac2e2e2435 from main
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-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-23Removed reference to flake8 file exclusions.Jacob Walls
Obsolete since 41384812efe209c8295a50d78b45e0ffb2992436. (six was removed in 9285926295fbfc86b70e7be8d595d4cfbe7895b8.)
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-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-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-05-13Updated guidance to propose new feature ideas in contributing docs.Lily Foote
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-03-31Fixes #36215 -- Included unpacking generalization notes in coding style ↵Aarni Koskela
guide (PEP-448).
2025-03-21Fixed #36138 -- Changed ADMINS and MANAGERS settings to lists of strings.Mike Edmunds
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-02-19Fixed #35908 -- Retired the django-developers and django-users mailing lists.Sarah Boyce
Co-authored-by: Chaitanya Rahalkar <chaitanyarahalkar@squareup.com>
2025-01-28Refs #36005 -- Bumped minimum supported versions of 3rd-party packages.Mariusz Felisiak
This bumps minimum supported versions of 3rd-party packages to the first releases to support Python 3.12.
2025-01-22Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing ↵Baptiste Mispelon
the Discord server.
2025-01-20Refs #32193 -- Updated python-memcached to pymemcache in contributing guide.Mariusz Felisiak
Follow up to 05f3a6186efefc9fca2204a745b992501c6fd91f.
2025-01-20Fixed #36005 -- Dropped support for Python 3.10 and 3.11.Mariusz Felisiak
2025-01-15Removed versionadded/changed annotations for 5.1.Sarah Boyce
This also removes remaining versionadded/changed annotations for older versions.
2025-01-08Fixed #35999 -- Removed #django IRC channel references where appropriate.Sarah Boyce
Some references are replaced with links to the Django Discord server.
2024-11-27Removed trailing whitespace in docs.Adam Zapletal
2024-11-14Replaced message suggestions from IRC to Discord in contributing docs.AfiMaameDufie
2024-11-11Refs #32365 -- Removed pytz from list of test dependencies in unit test docs.Mariusz Felisiak
Follow up to e6f82438d4e3750e8d299bfd79dac98eebe9f1e0.
2024-11-06Fixed #35863 -- Replaced bold text with heading level 3 in new contributors ↵ssanger
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-05Clarified instructions on how to claim a ticket.Maria Hynes
2024-10-30Fixed #35866 -- Clarified the positioning Python magic methods on models in ↵maddrum
the internal style guide.
2024-10-25Improved the writing documentation contributing guide.Paolo Melchiorre
2024-10-25Improved readability of triage workflow image by increasing its size and ↵mbcodes
color contrast.
2024-10-16Expanded contributor docs on getting feedback from the wider community.Maryam Yusuf
2024-08-28Fixed #35666 -- Documented stacklevel usage and testing, and adjusted test ↵Simon Charette
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-05Used :pypi: role in docs where appropriate.Mariusz Felisiak
2024-07-29Fixed #35546 -- Emphasised accepted ticket requirement in contributing docs.Maryam Yusuf
2024-07-29Referenced joining the triage and review team as motivation to do PR reviews.Maryam Yusuf