summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code/submitting-patches.txt
AgeCommit message (Collapse)Author
2026-03-20Made it clear that unreviewed tickets shouldn't be claimed or started.Jake Howard
2026-03-12Discouraged automated AI reviews of pull requests.Natalia
Some contributors have been requesting Copilot reviews on pull requests submitted to the Django repository. These automated reviews add noise to the PR history, making it harder to follow the discussion, and Django does not incorporate them into its review process. This change discourages the practice by: - Adding a `copilot-instructions.md` file instructing Copilot to decline review requests in this repository. - Adding a checklist item to the PR template asking contributors not to request automated AI reviews for their PR. - Documenting the policy in the contributing guidelines.
2026-02-10Clarified optional nature of Contributor License Agreement.Jacob Walls
It's not clear that CLAs are needed to ensure contributors are assenting to our license (the "inbound=outbound" agreement), but we can keep them around for contributors who would like to (or are required by their employer) to submit one, without investing additional resources in checking every single contribution. See https://forum.djangoproject.com/t/cla-vs-dco-for-django-contributors/42399 and recent board minutes.
2026-01-08Added guidance on AI-assisted code submission to contributing docs.Natalia
2025-12-07Refs #36620 -- Added contributor documentation for code coverage reports.saurabh
This was included in the original reverted patch: a89183e63844a937aacd3ddb73c4952ef869d2cc Follow-up to 26b0e2bb92caf2d16cabe455792350f20d6f42ca.
2025-11-25Reverted "Fixed #36620 -- Added coverage workflow to summarize coverage in ↵Natalia
pull requests." This reverts commit a89183e63844a937aacd3ddb73c4952ef869d2cc.
2025-11-21Fixed #36620 -- Added coverage workflow to summarize coverage in pull requests.saurabh
Part of GSoC 2025. Thanks Lily for mentorship, and Sarah Boyce and Jacob Walls for reviews.
2025-11-21Added GitHub Actions linter (zizmor).Jacob Walls
At the direction of the Security Team. Thanks Markus Holtermann, Jake Howard, and Natalia Bidart for reviews.
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-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-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-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-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-02-19Fixed #35908 -- Retired the django-developers and django-users mailing lists.Sarah Boyce
Co-authored-by: Chaitanya Rahalkar <chaitanyarahalkar@squareup.com>
2024-11-05Clarified instructions on how to claim a ticket.Maria Hynes
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-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-04Replaced usage of "patch" with more precise terms in contributing docs.Andreu Vallbona
2024-01-26Applied Black's 2024 stable style.Mariusz Felisiak
https://github.com/psf/black/releases/tag/24.1.0
2023-05-22Fixed #34579 -- Added Django Forum to contributing guides.Mohit Singh Sinsniwal
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-04-19Doc'd RemovedInDjangoXXWarning comments in deprecating a feature guide.Sarah Boyce
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
2022-08-09Fixed #33842 -- Used :source: role for links to repo files on GitHub.Ramil Yanbulatov
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-02-07Refs #33476 -- Adjusted docs and config files for Black.Carlton Gibson
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
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/
2020-12-23Fixed #32165 -- Added pre-commit hooksDavid Smith
* Added pre-commit hooks for isort, flake8 and eslint * Added documentation on how to install and use the tool
2020-05-04Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and ↵Adam Johnson
comments.
2020-04-14Fixed term warning on Sphinx 3.0.1+.Mariusz Felisiak
"term" role became case sensitive in Sphinx 3.0.1.
2020-02-03Fixed #31226 -- Fixed typo in ↵Vibhu Agarwal
docs/internals/contributing/writing-code/submitting-patches.txt.
2019-10-30Fixed #30927 -- Simplified an example of test for the deprecation warning ↵André Ericson
with assertWarnsMessage().
2019-09-06Fixed #30573 -- Rephrased documentation to avoid words that minimise the ↵Tobias Kunze
involved difficulty. This patch does not remove all occurrences of the words in question. Rather, I went through all of the occurrences of the words listed below, and judged if they a) suggested the reader had some kind of knowledge/experience, and b) if they added anything of value (including tone of voice, etc). I left most of the words alone. I looked at the following words: - simply/simple - easy/easier/easiest - obvious - just - merely - straightforward - ridiculous Thanks to Carlton Gibson for guidance on how to approach this issue, and to Tim Bell for providing the idea. But the enormous lion's share of thanks go to Adam Johnson for his patient and helpful review.
2018-04-06Updated contributing docs for some latest practices.Tim Graham
2018-03-28Replaced 'python -Wall' with 'python -Wa'.Daniel Chimeno
2016-12-21Removed the importance of "core developers" in triaging tickets, etc.Tim Graham
2016-06-03Fixed #26701 -- Replaced /newticket links to Trac with /.shaunagm
2016-01-22Fixed #26020 -- Normalized header stylings in docs.Elif T. Kus
2015-11-16Corrected outdated information in submitting patches guide.Tim Graham
2015-09-23Removed versionadded/changed annotations for 1.8.Tim Graham
2015-06-27Fixed #22463 -- Added code style guide and JavaScript linting (EditorConfig ↵Trey Hunner
and ESLint)
2015-06-25Updated release process for new release schedule.Tim Graham
2015-06-05Capitalized "Python" in docs.Tim Graham