Jacob Walls
a486455125
[5.2.x] Corrected definition of "needsinfo" triage stage in contributing guide.
...
Backport of 66082a7dac from main
2025-08-27 09:22:26 -04:00
Jacob Walls
f8e572e843
[5.2.x] Removed reference to flake8 file exclusions.
...
Obsolete since 41384812ef .
(six was removed in 9285926295fbfc86b70e7be8d595d4cfbe7895b8.)
Backport of 165ad74c57 from main
2025-08-23 20:06:54 +02:00
David Smith
a9c7d4b703
[5.2.x] Refs #36485 -- Grouped docs checks under a unified make check target.
...
Added a new 'check' rule to the docs Makefile which runs both the black
and spelling checks.
Backport of 7f9bf357fe from main.
2025-08-05 12:20:13 -03:00
David Smith
5ad6d43cd9
[5.2.x] Refs #34140 -- Added dedicated code block formatting section in docs/internals/contributing/writing-documentation.txt.
...
Backport of cba7328196 from main.
2025-08-05 12:20:04 -03:00
Jordan Bae
28f33f50b2
[5.2.x] Moved manual testing instructions from intro to submitting patches docs.
...
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 fdeca38072 from main.
2025-07-28 09:02:15 -03:00
Thibaud Colas
6e71386118
[5.2.x] Added accessibility guidelines for contributors.
...
Backport of 5527df9192 from main.
2025-07-23 16:42:23 +02:00
Tim Schilling
e5080fc5e9
[5.2.x] Added Django ecosystem page to the documentation.
...
Backport of 395e498553 from main
2025-07-13 15:06:58 +02:00
Lily Foote
817ed81aea
[5.2.x] Updated guidance to propose new feature ideas in contributing docs.
...
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 188799e67c from main.
2025-05-13 21:40:21 -03:00
Aarni Koskela
0581ec2f1a
[5.2.x] Fixes #36215 -- Included unpacking generalization notes in coding style guide (PEP-448).
...
Backport of 6b32506739 from main.
2025-03-31 22:44:35 -03:00
Sarah Boyce
463e87e249
[5.2.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists.
...
Co-authored-by: Chaitanya Rahalkar <chaitanyarahalkar@squareup.com >
Backport of 86493307f9 from main.
2025-02-19 12:16:20 +01:00
Baptiste Mispelon
d6c2b67884
[5.2.x] Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server.
...
Backport of 9a1f18635f from main.
2025-01-22 18:23:33 -03:00
Mariusz Felisiak
55afe50aca
[5.2.x] Refs #32193 -- Updated python-memcached to pymemcache in contributing guide.
...
Follow up to 05f3a6186e .
Backport of 337c641abb from main
2025-01-20 22:44:34 +01:00
Sarah Boyce
15e207ce80
Fixed #35999 -- Removed #django IRC channel references where appropriate.
...
Some references are replaced with links to the Django Discord server.
2025-01-08 10:24:52 +01:00
Adam Zapletal
e9ed5da3cb
Removed trailing whitespace in docs.
2024-11-27 13:13:28 -03:00
AfiMaameDufie
da2432ccca
Replaced message suggestions from IRC to Discord in contributing docs.
2024-11-14 11:36:16 +01:00
Mariusz Felisiak
46eb256cce
Refs #32365 -- Removed pytz from list of test dependencies in unit test docs.
...
Follow up to e6f82438d4 .
2024-11-11 12:24:21 +01:00
ssanger
c4c076223e
Fixed #35863 -- Replaced bold text with heading level 3 in new contributors 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-06 17:03:21 +01:00
Maria Hynes
db5980ddd1
Clarified instructions on how to claim a ticket.
2024-11-05 16:59:34 +01:00
maddrum
b50d1a020d
Fixed #35866 -- Clarified the positioning Python magic methods on models in the internal style guide.
2024-10-30 16:21:57 +01:00
Paolo Melchiorre
b5669f08bc
Improved the writing documentation contributing guide.
2024-10-25 16:35:35 +02:00
mbcodes
c973d9ee82
Improved readability of triage workflow image by increasing its size and color contrast.
2024-10-25 10:00:33 +02:00
Maryam Yusuf
438fc42ac6
Expanded contributor docs on getting feedback from the wider community.
2024-10-16 13:23:19 +02:00
Simon Charette
57307bbc7d
Fixed #35666 -- Documented stacklevel usage and testing, and 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.
2024-08-28 11:44:05 -03:00
Mariusz Felisiak
304d256674
Used :pypi: role in docs where appropriate.
2024-08-05 10:35:50 -03:00
Maryam Yusuf
7e00fee3bd
Fixed #35546 -- Emphasised accepted ticket requirement in contributing docs.
2024-07-29 15:12:43 +02:00
Maryam Yusuf
9d10c7ab33
Referenced joining the triage and review team as motivation to do PR reviews.
2024-07-29 14:46:10 +02:00
Sarah Boyce
2c024c9ac0
Added contributor guidelines for performance optimizations.
2024-07-25 09:25:25 +02:00
Mariusz Felisiak
df35cf578f
Updated asgiref dependency for 5.1 release series.
2024-07-24 08:21:07 +02:00
Andreu Vallbona
55a2e3136b
Replaced usage of "patch" with more precise terms in contributing docs.
2024-07-04 17:52:19 -03:00
Claude Paroz
4686541691
Migrated setuptools configuration to pyproject.toml.
...
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-06-24 15:34:43 -03:00
Sarah Boyce
39828fa778
Added a high contrast mode to screenshot cases.
...
Thank you to Sarah Abderemane and Nick Pope for the reviews.
2024-05-02 13:18:58 +02:00
Ryan Cheley
f2c3524959
Fixed #14831 -- Extended template style guide in docs.
2024-03-11 11:05:54 +01:00
Mariusz Felisiak
177e649396
Fixed broken links and redirects in docs.
2024-03-06 08:50:21 +01:00
Koo
aaffbabd58
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.
2024-02-08 05:57:59 +01:00
Mariusz Felisiak
305757aec1
Applied Black's 2024 stable style.
...
https://github.com/psf/black/releases/tag/24.1.0
2024-01-26 12:45:07 +01:00
Mark Walker
4eb4ab4122
Reorganized the Contributing to Django docs.
...
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 >
2024-01-11 22:25:27 -03:00
Mark Walker
6ab0f8ae52
Improved structure of Contributing Guide start page.
2023-11-30 08:33:29 +01:00
Lance Goyke
a680ac7d77
Restructured writing documentation contributing guide.
...
This trims and clearly delineates the how to guide from the subsequent
explanation with additional subheadings.
These changes have been discussed with Daniele Procida
at the DjangoCon US 2023 sprints.
2023-10-21 09:44:36 +02:00
David Smith
1611577102
Corrected note about using accents in writing documentation contributing guide.
2023-10-21 09:39:16 +02:00
Sarah Boyce
be56c982c0
Refs #34043 -- Added --screenshots option to runtests.py and selenium tests.
2023-10-18 06:14:40 +02:00
sarahboyce
e083f3082c
Refs #34043 -- Clarified how to test UI changes.
2023-10-09 10:45:29 +02:00
Mariusz Felisiak
295467c04a
Removed versionadded/changed annotations for 4.2.
...
This also removes remaining versionadded/changed annotations for older
versions.
2023-09-18 22:12:40 +02:00
Jacob Walls
6c6606aa01
Refs #34233 -- Bumped minimum supported version of docutils to 0.19.
2023-09-04 22:30:45 +02:00
Sulabh Katila
9a9620dda6
Fixed #34768 -- Avoided initializing colorama on non-Windows platforms.
2023-09-01 11:26:29 +02:00
Nick Pope
500e01073a
Fixed #31262 -- Added support for mappings on model fields and ChoiceField's choices.
2023-08-30 22:57:40 -03:00
Mariusz Felisiak
370a021780
Refs #34233 -- Bumped minimum supported version of Selenium to 4.8.0.
...
This bumps minimum supported versions of selenium to the first release
to support Python 3.10.
2023-06-26 14:22:54 +02:00
Mariusz Felisiak
650ce96782
Refs #34391 -- Updated asgiref dependency for 5.0 release series.
2023-06-23 21:52:04 +02:00
Mariusz Felisiak
06881341d4
Refs #30220 -- Bumped required version of Selenium to 3.8.0.
...
Follow up to 8d010f3986 .
2023-06-13 10:12:52 +02:00
Mohit Singh Sinsniwal
89f10a80d7
Fixed #34579 -- Added Django Forum to contributing guides.
...
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com >
2023-05-22 20:21:18 +02:00
Mariusz Felisiak
93830abf76
Updated broken links in docs.
2023-05-17 12:13:10 +02:00