[Django] #34043: Doc "Writing your first patch for Django" doesn't explain how to contribute to the admin UI
Django
to the admin UI
-----------------------------------------+------------------------
Reporter: Hugo Herter | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version:
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 1 |
-----------------------------------------+------------------------
The documentation
[https://docs.djangoproject.com/en/dev/intro/contributing/ Writing your
first patch for Django ] is aimed to help new contributors to contribute
to Django.
This documentation is focused on the test suite, and does not include any
help on how to run the Admin. This makes it difficult for newcomers to
contribute to UI enhancements of the Django Admin, or to test and review
changes in pull requests that include UI changes.
This would make it much easier to work on tickets such as #34033, #34036,
#34037, ...
== Proposal
Add a section in this page that explains how to automatically start a
sample project pre-populated with enough test data to test most builtin UI
features and widgets.
I was recommended by @thibaudcolas to use [https://github.com/knyghty
/django-admin-demo this django-admin-demo] project to test the admin. That
project appears to be a good start, but requires dependencies unrelated to
Django such as `spotipy`, and is hosted by a third party instead of being
(part of) an official Django repository.
== Questions
Would the sample project be part of the official Django repository or be a
different repository ?
Does Django have test suites and tooling to keep track of UI changes
automatically ? <br/>
Something like https://percy.io/ (proprietary, cloud, sketchy example).
--
Ticket URL: <https://code.djangoproject.com/ticket/34043>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
to the admin UI
Reporter: Hugo Herter | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
Old description:
New description:
The documentation
[https://docs.djangoproject.com/en/dev/intro/contributing/ Writing your
first patch for Django ] is aimed to help new contributors to contribute
to Django.
This documentation is focused on the test suite, and does not include any
help on how to run the Admin. This makes it difficult for newcomers to
contribute to UI enhancements of the Django Admin, or to test and review
changes in pull requests that include UI changes.
This would make it much easier to work on tickets such as #34033, #34036,
#34037, ...
== Proposal
Add a section in this page that explains how to automatically start a
sample project pre-populated with enough test data to test most builtin UI
features and widgets.
I was recommended by @thibaudcolas to use [https://github.com/knyghty
/django-admin-demo this django-admin-demo] project to test the admin. That
project appears to be a good start, but requires dependencies unrelated to
Django such as `spotipy`, and is hosted by a third party instead of being
(part of) an official Django repository.
== Questions
Would the sample project be part of the official Django repository or be a
different repository ?
Does Django have test suites and tooling to keep track of UI changes
automatically ?
Something like https://percy.io/ (proprietary, cloud, sketchy example).
--
Comment (by Hugo Herter):
Remove unsupported HTML tag
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:1>
Django
to the admin UI
-------------------------------+--------------------------------------
Reporter: Hugo Herter | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+--------------------------------------
Comment (by Thibaud Colas):
For context, [https://github.com/knyghty/django-admin-demo this django-
admin-demo] is a project set up by Tom so we have a dedicated, fully-
featured Django admin to test accessibility issues on. I have a similar
[https://github.com/thibaudcolas/django_admin_tests django_admin_tests]
project for the same purpose, but I’ve largely stopped using it as it
doesn’t cover as much of the admin’s features as Tom’s.
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:2>
Django
to the admin UI
-------------------------------+------------------------------------
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+------------------------------------
* version: => dev
* type: Uncategorized => New feature
* stage: Unreviewed => Accepted
Comment:
Thanks for the suggestion here. I think it's a good idea.
I see two phases here:
1. Can we improve the documentation?
2. Can we add a test project template?
On 1, there is the **smallest** of mentions in the ''Writing your first
patch for Django'' tutorial. See the
[https://docs.djangoproject.com/en/4.1/intro/contributing/#creating-
projects-with-a-local-copy-of-django Creating projects with a local copy
of Django] section.
So, question, does that need to be expanded, or put some somewhere more
prominent, or …? Had you seen that at all? Does it say enough even once
you have? (Likely not on that last)
Then on 2: I think a repo under the GitHub Django org with one or more
project templates that could be used with `startproject` and the
`--template` option would be handy. Perhaps using some of the models from
the docs. Perhaps providing fixtures so `loaddata` has something to work
on. Then linked to from the Django docs. I think that would be a great
resource. If you want to draft something and let me know we can get it set
up on GitHub.
Part 1 is clearly addressable under the scope of this issue tracker, so
let's accept for that. (It might be that we could close after that if 2
it's progressing at that time… — always allowing an update once such
exists, if that makes sense.)
🎁
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:3>
Django
to the admin UI
Reporter: Hugo Herter | Owner: MauryaRitesh
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
Changes (by MauryaRitesh):
* owner: nobody => MauryaRitesh
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:4>
Django
to the admin UI
-------------------------------+----------------------------------------
Reporter: Hugo Herter | Owner: MauryaRitesh
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+----------------------------------------
* cc: Sarah Boyce (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:5>
Django
to the admin UI
-------------------------------+---------------------------------------
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+---------------------------------------
* owner: MauryaRitesh => Sarah Boyce
* has_patch: 0 => 1
Comment:
PR: https://github.com/django/django/pull/16963
This hopes to slightly improve the documentation and adds UI testing into
our CI.
The phase two of having a test project is difficult to maintain and
unlikely to have every widget possibility. I think it's fair to say if you
want to update an area, you can create a small project that has the
specific thing you're testing.
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:6>
Django
to the admin UI
-------------------------------+---------------------------------------
Reporter: Hugo Herter | Owner: Sarah Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+---------------------------------------
* needs_docs: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:7>
Django
to the admin UI
-------------------------------+---------------------------------------
Reporter: Hugo Herter | Owner: Sarah Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+---------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"e083f3082c71853a01bf149bda7fdbaf58d25f4d" e083f308]:
{{{
#!CommitTicketReference repository=""
revision="e083f3082c71853a01bf149bda7fdbaf58d25f4d"
Refs #34043 -- Clarified how to test UI changes.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:8>
Django
to the admin UI
-------------------------------+---------------------------------------
Reporter: Hugo Herter | Owner: Sarah Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+---------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"33ad36a8ec21ea67308fc715ed0d1f581faf12b8" 33ad36a8]:
{{{
#!CommitTicketReference repository=""
revision="33ad36a8ec21ea67308fc715ed0d1f581faf12b8"
[5.0.x] Refs #34043 -- Clarified how to test UI changes.
Backport of e083f3082c71853a01bf149bda7fdbaf58d25f4d from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:9>
Django
to the admin UI
-------------------------------+---------------------------------------
Reporter: Hugo Herter | Owner: Sarah Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+---------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"9c7627da3024923ed9f4364523db2524fef363fd" 9c7627d]:
{{{
#!CommitTicketReference repository=""
revision="9c7627da3024923ed9f4364523db2524fef363fd"
[4.2.x] Refs #34043 -- Clarified how to test UI changes.
Backport of e083f3082c71853a01bf149bda7fdbaf58d25f4d from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:10>
Django
to the admin UI
-------------------------------+---------------------------------------
Reporter: Hugo Herter | Owner: Sarah Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+---------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"f6629ee2c986d3bf59b4c1b3058f370a00bdc573" f6629ee]:
{{{
#!CommitTicketReference repository=""
revision="f6629ee2c986d3bf59b4c1b3058f370a00bdc573"
Refs #34043 -- Added context managers to SeleniumTestCase for changing
window size.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:11>
Django
to the admin UI
-------------------------------+---------------------------------------
Reporter: Hugo Herter | Owner: Sarah Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+---------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"be56c982c0805f62a2948d9d7a3e21215c352174" be56c982]:
{{{
#!CommitTicketReference repository=""
revision="be56c982c0805f62a2948d9d7a3e21215c352174"
Refs #34043 -- Added --screenshots option to runtests.py and selenium
tests.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:12>
Django
to the admin UI
-------------------------------+---------------------------------------
Reporter: Hugo Herter | Owner: Sarah Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------+---------------------------------------
* needs_docs: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:13>
Django
to the admin UI
Reporter: Hugo Herter | Owner: Sarah
| Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
Changes (by Mariusz Felisiak):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:14>
Django
to the admin UI
-------------------------------------+-------------------------------------
Reporter: Hugo Herter | Owner: Sarah
| Boyce
Type: New feature | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"97b7970c6479ef414175f22a009240ed0df8ce46" 97b7970c]:
{{{
#!CommitTicketReference repository=""
revision="97b7970c6479ef414175f22a009240ed0df8ce46"
Refs #34043 -- Added GitHub action to capture screenshots in Selenium
tests.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:15>
Django
to the admin UI
-------------------------------------+-------------------------------------
Reporter: Hugo Herter | Owner: Sarah
| Boyce
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:16>
Django
to the admin UI
-------------------------------------+-------------------------------------
Reporter: Hugo Herter | Owner: Sarah
| Boyce
Type: New feature | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
Comment (by GitHub <noreply@…>):
In [changeset:"3b255d72cf73e89ac1dc94d74467e5e4c487f5f2" 3b255d72]:
{{{
#!CommitTicketReference repository=""
revision="3b255d72cf73e89ac1dc94d74467e5e4c487f5f2"
Refs #34043 -- Tweaked wording in release note.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/34043#comment:17>