#34043: Doc "Writing your first patch for Django" doesn't explain how to
contribute
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
-------------------------------+--------------------------------------
Old 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 ? <br/>
> Something like https://percy.io/ (proprietary, cloud, sketchy example).
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 <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/010701836ee62b1b-a46df8f0-6318-4d01-837f-5c98d9090c88-000000%40eu-central-1.amazonses.com.
