From 6dc48a735c2d98c4d1e5a56cb99d62a3631c3bcd Mon Sep 17 00:00:00 2001
From: Idan Gazit <idan@gazit.me>
Date: Sun, 28 Aug 2011 14:43:51 +0000
Subject: [PATCH] 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
---
.../contributing/bugs-and-features.txt | 26 +++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/docs/internals/contributing/bugs-and-features.txt b/docs/internals/contributing/bugs-and-features.txt
index 2ab3d9236c..87c0f04aec 100644
--- a/docs/internals/contributing/bugs-and-features.txt
+++ b/docs/internals/contributing/bugs-and-features.txt
@@ -89,6 +89,32 @@ following actions:
go-public date. This will probably mean a new release of Django, but
in some cases it may simply be patches against current releases.
+Reporting user interface bugs and features
+------------------------------------------
+
+If your bug or feature request touches on anything visual in nature, there
+are a few additional guidelines to follow:
+
+ * Include screenshots in your ticket which are the visual equivalent of a
+ minimal testcase. Show off the issue, not the crazy customizations
+ you've made to your browser.
+
+ * If the issue is difficult to show off using a still image, consider
+ capturing a *brief* screencast. If your software permits it, capture only
+ the relevant area of the screen.
+
+ * If you're offering a patch which changes the look or behavior of Django's
+ UI, you **must** attach before *and* after screenshots/screencasts.
+ Tickets lacking these are difficult for triagers and core developers to
+ assess quickly.
+
+ * Screenshots don't absolve you of other good reporting practices. Make sure
+ to include URLs, code snippets, and step-by-step instructions on how to
+ reproduce the behavior visible in the screenshots.
+
+ * Make sure to set the UI/UX flag on the ticket so interested parties can
+ find your ticket.
+
Requesting features
-------------------