Skip to content

Commit

Permalink
Added guidelines for reporting UI-related bugs & feature requests.
Browse files Browse the repository at this point in the history
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16707 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
idan committed Aug 28, 2011
1 parent 6757568 commit 6dc48a7
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/internals/contributing/bugs-and-features.txt
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -89,6 +89,32 @@ following actions:
go-public date. This will probably mean a new release of Django, but go-public date. This will probably mean a new release of Django, but
in some cases it may simply be patches against current releases. 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 Requesting features
------------------- -------------------


Expand Down

0 comments on commit 6dc48a7

Please sign in to comment.