summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code
AgeCommit message (Collapse)Author
2025-11-21[5.2.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-08-23[5.2.x] Removed reference to flake8 file exclusions.Jacob Walls
Obsolete since 41384812efe209c8295a50d78b45e0ffb2992436. (six was removed in 9285926295fbfc86b70e7be8d595d4cfbe7895b8.) Backport of 165ad74c578f94f962624a40dff14e1b2e23a1f8 from main
2025-07-28[5.2.x] Moved 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. Backport of fdeca380724d523330db9d816c4cda50cda320fd from main.
2025-07-23[5.2.x] Added accessibility guidelines for contributors.Thibaud Colas
Backport of 5527df91921b54b9fd1eb9aca3aabe91ec58a9c7 from main.
2025-05-13[5.2.x] Updated 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> Backport of 188799e67c2c497419f448359775930c866fe28d from main.
2025-03-31[5.2.x] Fixes #36215 -- Included unpacking generalization notes in coding ↵Aarni Koskela
style guide (PEP-448). Backport of 6b3250673937b105af44f2f14247e56876f8dbe1 from main.
2025-02-19[5.2.x] Fixed #35908 -- Retired the django-developers and django-users ↵Sarah Boyce
mailing lists. Co-authored-by: Chaitanya Rahalkar <chaitanyarahalkar@squareup.com> Backport of 86493307f97b9795a74227b6af2d59a267160847 from main.
2025-01-20[5.2.x] Refs #32193 -- Updated python-memcached to pymemcache in ↵Mariusz Felisiak
contributing guide. Follow up to 05f3a6186efefc9fca2204a745b992501c6fd91f. Backport of 337c641abb36b3c2501b14e1290b800831bb20ad from main
2024-11-11Refs #32365 -- Removed pytz from list of test dependencies in unit test docs.Mariusz Felisiak
Follow up to e6f82438d4e3750e8d299bfd79dac98eebe9f1e0.
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-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
2024-07-25Added contributor guidelines for performance optimizations.Sarah Boyce
2024-07-24Updated asgiref dependency for 5.1 release series.Mariusz Felisiak
2024-07-04Replaced usage of "patch" with more precise terms in contributing docs.Andreu Vallbona
2024-06-24Migrated setuptools configuration to pyproject.toml.Claude Paroz
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-05-02Added a high contrast mode to screenshot cases.Sarah Boyce
Thank you to Sarah Abderemane and Nick Pope for the reviews.
2024-03-11Fixed #14831 -- Extended template style guide in docs.Ryan Cheley
2024-03-06Fixed broken links and redirects in docs.Mariusz Felisiak
2024-02-08Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.Koo
2024-01-26Applied Black's 2024 stable style.Mariusz Felisiak
https://github.com/psf/black/releases/tag/24.1.0
2024-01-11Reorganized the Contributing to Django docs.Mark Walker
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>
2023-10-18Refs #34043 -- Added --screenshots option to runtests.py and selenium tests.Sarah Boyce
2023-10-09Refs #34043 -- Clarified how to test UI changes.sarahboyce
2023-09-04Refs #34233 -- Bumped minimum supported version of docutils to 0.19.Jacob Walls
2023-09-01Fixed #34768 -- Avoided initializing colorama on non-Windows platforms.Sulabh Katila
2023-08-30 Fixed #31262 -- Added support for mappings on model fields and ↵Nick Pope
ChoiceField's choices.
2023-06-26Refs #34233 -- Bumped minimum supported version of Selenium to 4.8.0.Mariusz Felisiak
This bumps minimum supported versions of selenium to the first release to support Python 3.10.
2023-06-23Refs #34391 -- Updated asgiref dependency for 5.0 release series.Mariusz Felisiak
2023-06-13Refs #30220 -- Bumped required version of Selenium to 3.8.0.Mariusz Felisiak
Follow up to 8d010f39869f107820421631111417298d1c5bb9.
2023-05-22Fixed #34579 -- Added Django Forum to contributing guides.Mohit Singh Sinsniwal
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-05-17Updated broken links in docs.Mariusz Felisiak
2023-04-27Restored multiprocessing concurrency on coverage.py settingsMarc Gibbons
* Revert "Reverted "Fixed #33213 -- Doc'd testing code coverage in parallel and used it."" This reverts commit 78da5ca0c1f2ab3201f8f6cd629e80d805ea023d. * Restored coverage multiprocess concurrency with threads Investigating https://github.com/nedbat/coveragepy/issues/1585 revealed that thread tracing gets disabled when passing `concurrency = multiprocessing`. Adding `thread` restores it, and ensures that the `auser()` is reported as covered since the test suite uses `AsyncToSync` to execute this middleware (which spawns threads).
2023-04-19Doc'd RemovedInDjangoXXWarning comments in deprecating a feature guide.Sarah Boyce
2023-04-17Used extlinks for PyPI links.Tim Graham
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-03-30Fixed #34446 -- Removed unneeded and incorrect example in coding style docs.JiriKr
2023-03-15Reverted "Fixed #33213 -- Doc'd testing code coverage in parallel and used it."Mariusz Felisiak
This reverts commit 69352d85fa8412865db9e0c7f177b333c0eac3e2. Test coverage for async methods was no longer calculated with this change.
2023-03-01Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.django-bot
2023-03-01Refs #34140 -- Added configurations to run blacken-docs linter and adjusted ↵Mariusz Felisiak
docs. This adds: - GitHub actions, - tox configuration, - pre-commit hook, and - makefile rules to run blacken-docs linter. Co-authored-by: David Smith <smithdc@gmail.com>
2023-02-28Refs #34140 -- Corrected rst code-block and various formatting issues in docs.Joseph Victor Zammit
2023-02-11Fixed #33213 -- Doc'd testing code coverage in parallel and used it.Paolo Melchiorre
2023-02-10Refs #34140 -- Applied rst code-block to non-Python examples.Carlton Gibson
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for reviews.
2023-01-18Fixed #34233 -- Dropped support for Python 3.8 and 3.9.Mariusz Felisiak
2023-01-05Refs #32355 -- 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.8.
2022-12-20Refs #34118 -- Adopted asgiref coroutine detection shims.Carlton Gibson
Thanks to Mariusz Felisiak for review.
2022-10-24Improved "rebase" example for upstream changes in working with Git docs.Smile
generated by cgit v1.3 (git 2.53.0) at 2026-05-02 02:10:09 +0000