Bug reporting guide

This is a CouchSurfing bug reporting guide. As of October 2006 we're using a public Bug Tracker, which will hopefully greatly increase both transparency and user participation. Check Mantis guide for CS bug reporters.

Bug, usability issue, or feature request?

It is important to distinguish between bugs in the existing software, usability issues, and feature requests.

Some help with the terms: Tech-people-tech Vocabulary

A bug means that something does not work with the current version of the site. Examples:

• broken link
• cannot log in on the site
• crashes your browser

1. Report bugs on our new and shiny bug tracker :) intructions for this will be found here: Mantis guide for CS bug reporters or if this feels too technical...
2. Report bugs on group Is there a cockroach in the system - report the BUG
3. A location problem can directly be mentioned on the wiki at Wrong locations.

Be sure to include the steps to reproduce the bug you just found!

A usability issue is when something is hard or annoying to use. It takes a bit too long to figure out, or requires a bit too much effort. Sometimes you can live with it and it's not a big deal, but sometimes it is such a hassle that you give up.

1. Report usability issues on group Porcupine in the system! Usability issues...

A feature request is a suggestion for improvement of currently existing features or new cool features. Examples:

• It would be cool to have travel guide functionality on CS.
• We really need a ride share system.
• Country codes should be displayed next to chat nicknames

1. Report feature requests on group Storm of Brain - Brainstorm
2. Work on a detailed description of the feature on this wiki.

Bug reporting & fixing process in Couchsurfing (to be refined...)

1. Write your bug report on group: Is there a cockroach in the system - report the BUG or if you are more technically-minded, on the Bug Tracker.
   Write a detailed report of what you were doing before you realized there's a bug. What page you were on, what links you clicked, what information you wrote in the text fields.
2. The Group is being watched by volunteers and all new bugs will be reported on a bug tracking system (if you didn't add it already)
3. Bug fixes are done by Casey or other programmers
4. Bug fixes are updated on the live server as soon as they have been verified to be working locally (ie on the programmer's computer) and people who can upload them have been notified of update need. (Note: beta test server where bug fixes can be verified by beta-testers should be available soon)
5. Bug should be reported as fixed back in the Cockroach group and its status updated on the bug tracker.

Examples of ”bad” bug report

"The site doesn't work."

We need to know what part of the site you are looking at?

"E-mails won't work."

Are you trying to send e-mail? Receive e-mail? Getting e-mail on CouchSurfing but not forwarded to your personal e-mail?

Example of a ”good” bug report

Write:

• what you were doing (exact parameters are important so that the bug can be replicated & programmers have a startpoint for bug-squishing)
• what happened
• (what you think the bug is IF you have any ideas - don't worry if not, it will be investigated anyway :)
• Web-browser and version (can usually be found in Help->About in your browser menu) and
• Operating system

Example:

Title: Search bug when searching by language

I tried looking for Dutch-speaking people in Holland but had some trouble, see below.

Browsing with Firefox 1.5.07 on Windows XP

Search Parameters: Language: Dutch (Netherlands)
 Results: 101 to 86 out of 86 found
 (displaying none but a PREVIOUS page link) 
Let's click! Display: 
 1 to 86 out of 86 found.
 Yet, Aldo is nowhere to be found.

Search Parameters: Location: France Language: French
Results: 1 to 88 out of 88 found.
Is there only 88 members from France who speak French???csgroup:430