summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code
AgeCommit message (Collapse)Author
2024-08-28[5.1.x] Fixed #35666 -- Documented stacklevel usage and testing, and ↵Simon Charette
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. Backport of 57307bbc7d88927989cf5b314f16d6e13ade04e6 from main.
2024-08-05[5.1.x] Used :pypi: role in docs where appropriate.Mariusz Felisiak
Backport of 304d25667433a59409e334a93acaaa9201840508 from main.
2024-07-25[5.1.x] Added contributor guidelines for performance optimizations.Sarah Boyce
Backport of 2c024c9ac096d06d9e78d1ae02b52f73a45eadf8 from main.
2024-07-24[5.1.x] Updated asgiref dependency for 5.1 release series.Mariusz Felisiak
Backport of df35cf578f99522dd1ba864d513be95d47bab7a5 from main.
2024-07-04[5.1.x] Replaced usage of "patch" with more precise terms in contributing docs.Andreu Vallbona
Backport of 55a2e3136b13d1af95a4129001dac963c26d8415 from main.
2024-06-24[5.1.x] Migrated 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> Backport of 4686541691dbe986f58ac87630c3b7a04db4ff93 from main.
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
2022-10-24Fixed #34111 -- Made test runner with --debug-sql format SQL queries.Giebisch
2022-10-21Corrected curl call in working with Git docs.Smile
2022-08-09Fixed #33842 -- Used :source: role for links to repo files on GitHub.Ramil Yanbulatov
2022-06-27Fixed #33422 -- Improved docs about isolating apps.Christopher Adams
2022-06-16Updated asgiref dependency for 4.1 release series.Carlton Gibson
2022-05-31Fixed docs build with sphinxcontrib-spelling 7.5.0+.Mariusz Felisiak
sphinxcontrib-spelling 7.5.0+ includes captions of figures in the set of nodes for which the text is checked.
2022-05-17Removed versionadded/changed annotations for 4.0.Carlton Gibson
2022-03-29Updated various links to HTTPS and new locations.Mariusz Felisiak
2022-03-22Fixed #33585 -- Made example git repo URLs use HTTPS protocol.Carlton Gibson
The SSH-based checkout requires additional configuration, which is beneficial to defer for new contributors. Follow up to 3c6a4fdb6d828a03e368632d88f8261cc30104da. This commit updates the remaining examples.
2022-03-22Refs #31676 -- Used term "merger" instead of "committer" in docs.Mariusz Felisiak
Follow up to caa2dd08c4722c8702588f5dfe1fa4c506aa66fc. Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2022-03-10Changed some words to use inline markup.David Smith
2022-02-21Refs #33476 -- Mentioned black in docs about pre-commit checks.Vaarun Sinha
2022-02-07Refs #33476 -- Adjusted docs and config files for Black.Carlton Gibson
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2021-12-07Updated asgiref dependency for 4.0 release series.Mariusz Felisiak
generated by cgit v1.3 (git 2.53.0) at 2026-07-03 07:54:32 +0000