Opened 2 years ago
Last modified 13 months ago
#34043 closed New feature
Doc "Writing your first patch for Django" doesn't explain how to contribute to the admin UI — at Version 1
| Reported by: | Hugo Herter | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Thibaud Colas, Sarah Boyce | Triage Stage: | Ready for checkin |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | yes |
Description (last modified by )
The documentation 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 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).
Remove unsupported HTML tag