Skip to content

Commit 6dc48a7

Browse files
committed
Added guidelines for reporting UI-related bugs & feature requests.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16707 bcc190cf-cafb-0310-a4f2-bffc1f526a37
1 parent 6757568 commit 6dc48a7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/internals/contributing/bugs-and-features.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,32 @@ following actions:
8989
go-public date. This will probably mean a new release of Django, but
9090
in some cases it may simply be patches against current releases.
9191

92+
Reporting user interface bugs and features
93+
------------------------------------------
94+
95+
If your bug or feature request touches on anything visual in nature, there
96+
are a few additional guidelines to follow:
97+
98+
* Include screenshots in your ticket which are the visual equivalent of a
99+
minimal testcase. Show off the issue, not the crazy customizations
100+
you've made to your browser.
101+
102+
* If the issue is difficult to show off using a still image, consider
103+
capturing a *brief* screencast. If your software permits it, capture only
104+
the relevant area of the screen.
105+
106+
* If you're offering a patch which changes the look or behavior of Django's
107+
UI, you **must** attach before *and* after screenshots/screencasts.
108+
Tickets lacking these are difficult for triagers and core developers to
109+
assess quickly.
110+
111+
* Screenshots don't absolve you of other good reporting practices. Make sure
112+
to include URLs, code snippets, and step-by-step instructions on how to
113+
reproduce the behavior visible in the screenshots.
114+
115+
* Make sure to set the UI/UX flag on the ticket so interested parties can
116+
find your ticket.
117+
92118
Requesting features
93119
-------------------
94120

0 commit comments

Comments
 (0)