Author: idangazit
Date: 2011-08-28 07:43:51 -0700 (Sun, 28 Aug 2011)
New Revision: 16707
Modified:
django/trunk/docs/internals/contributing/bugs-and-features.txt
Log:
Added guidelines for reporting UI-related bugs & feature requests.
Modified: django/trunk/docs/internals/contributing/bugs-and-features.txt
===================================================================
--- django/trunk/docs/internals/contributing/bugs-and-features.txt
2011-08-28 13:51:28 UTC (rev 16706)
+++ django/trunk/docs/internals/contributing/bugs-and-features.txt
2011-08-28 14:43:51 UTC (rev 16707)
@@ -89,6 +89,32 @@
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
-------------------
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
