summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code
AgeCommit message (Collapse)Author
2025-08-04[4.2.x] Refs #36535 -- Doc'd that docutils < 0.22 is required.Natalia
Backport of 9d9b3bc71702e4bd4b7f8e1602d83fd69f871e94 from stable/5.1.x.
2025-05-05[4.2.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.
2023-10-09[4.2.x] Refs #34043 -- Clarified how to test UI changes.sarahboyce
Backport of e083f3082c71853a01bf149bda7fdbaf58d25f4d from main
2023-06-13[4.2.x] Refs #30220 -- Bumped required version of Selenium to 3.8.0.Mariusz Felisiak
Follow up to 8d010f39869f107820421631111417298d1c5bb9. Backport of 06881341d48dd17a4fdf25afc96991de4fb3b1ac from main
2023-05-23[4.2.x] Fixed #34579 -- Added Django Forum to contributing guides.Mohit Singh Sinsniwal
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com> Backport of 89f10a80d7e681cd0cccf22d932e380f51bd3524 from main
2023-05-17[4.2.x] Updated broken links in docs.Mariusz Felisiak
Backport of 93830abf7694e0f281931f10eeaa34993855e7dd from main
2023-04-19[4.2.x] Doc'd RemovedInDjangoXXWarning comments in deprecating a feature guide.Sarah Boyce
Backport of 1611a3af1cf18256db389f259a020414ec1226b4 from main
2023-04-17[4.2.x] Used extlinks for PyPI links.Tim Graham
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com> Backport of 2c4dc6476083c853b654e462c7ff65dbe0334c9e from main
2023-03-30[4.2.x] Fixed #34446 -- Removed unneeded and incorrect example in coding ↵JiriKr
style docs. Backport of cfe563ffaf01d22343717176d96bfca0d05f60fb from main
2023-03-01[4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.django-bot
2023-03-01[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and ↵Mariusz Felisiak
adjusted 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> Backport of 6015bab80e28aef2669f6fac53423aa65f70cb08 from main
2023-02-28[4.2.x] Refs #34140 -- Corrected rst code-block and various formatting ↵Joseph Victor Zammit
issues in docs. Backport of ba755ca13123d2691a0926ddb64e5d0a2906a880 from main
2023-02-10[4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples.Carlton Gibson
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for reviews. Backport of 534ac4829764f317cf2fbc4a18354fcc998c1425 from main.
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
2021-11-22Corrected isort example in coding style docs.Mariusz Felisiak
Follow up to e74b3d724e5ddfef96d1d66bd1c58e7aae26fc85.
2021-11-22Corrected "pip install" call in coding style docs.Paolo Melchiorre
2021-10-15Refs #32074 -- Removed usage of deprecated asyncore and smtpd modules.Mariusz Felisiak
asyncore and smtpd modules were deprecated in Python 3.10.
2021-09-14Fixed #33012 -- Added Redis cache backend.Daniyal
Thanks Carlton Gibson, Chris Jerdonek, David Smith, Keryn Knight, Mariusz Felisiak, and Nick Pope for reviews and mentoring this Google Summer of Code 2021 project.
2021-08-17Fixed #32964 -- Corrected 'setup'/'set up' usage in docs.Andrew Northall
2021-07-29Fixed 32956 -- Lowercased spelling of "web" and "web framework" where ↵David Smith
appropriate.
2021-07-08Fixed #24522 -- Added a --shuffle option to DiscoverRunner.Chris Jerdonek
2021-06-03Refs #31356 -- Changed IRC links to the Libera.Chat webchat.Mariusz Felisiak
Follow up to 66491f08fe86629fa25977bb3dddda06959f65e7.
2021-06-03Fixed typos in docs.Jacob Walls
2021-06-02Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.Jacob Walls
2021-05-20Changed IRC references to Libera.Chat.Mariusz Felisiak
2021-05-17Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS.Nick Pope
2021-04-29Refs #32178 -- Doc'd ↵Hasan Ramezani
DatabaseFeatures.django_test_skips/django_test_expected_failures in contributing guide.
2021-04-06Updated asgiref dependency for 3.2 release series.Carlton Gibson
2021-03-09Updated link to Selenium webdrivers.Mariusz Felisiak
2021-03-09Updated Git branch "master" to "main".Markus Holtermann
This change follows a long discussion on django-develops: https://groups.google.com/g/django-developers/c/tctDuKUGosc/
2021-03-03Refs #32412 -- Adjusted Contributing Guide start page.GabbyPrecious
* Added headers emphasising Work on the framework vs Join the community sections, to raise the visibility of the community section. * Added callouts to three main code/docs/translations areas, linking to respective start pages. * Moved some Writing code specific content from the start page to the Writing code index. This clarifies the start page and adds content to the previously empty Writing code index. Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2021-02-10Fixed #32355 -- Dropped support for Python 3.6 and 3.7Mariusz Felisiak
2021-01-09Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.hashlash
2020-12-23Refs #30367 -- Changed remaining "pip install" to "python -m pip install" in ↵Jon Dufresne
docs.