|
|
| (127 intermediate revisions by 25 users not shown) |
| Line 1: |
Line 1: |
| {{OSWikiContribBox|parent=QA}} | | {{TOCright}}{{multi-lang}} |
| | ''Is a feature not working as expected in your Second Life? You may have found a bug!'' |
|
| |
|
| '''<font color=red>The JIRA Issue Tracker is ''not'' for technical support-type requests.</font> If you're looking for account-specific help, please use our [http://secondlife.com/community/support.php support resources].''' | | == What's a bug? == |
|
| |
|
| The issue tracker, known as "Public JIRA", "PJIRA", or just "JIRA", is an issue-tracking project management tool made by [http://www.atlassian.com/software/jira Atlassian] and is used by the Second Life open source initiative. It is located at https://jira.secondlife.com and organizes issues (i.e. bugs and feature requests) submitted by the Second Life community into a searchable database. You, too, can submit issues you find when using the open source or standard versions of Second Life. Please familiarize yourself with the information in this page before proceeding to JIRA.
| | An unintended computer problem which happens for more than one person under the same conditions. |
|
| |
|
| '''NOTE''': All submissions to this site (JIRA included) are governed by the [[Project:Contribution_Agreement|Second Life Project Contribution Agreement]]. By submitting patches and other information using this site, you acknowledge that you've read, understood, and agreed to those terms.
| |
|
| |
|
| == How it works == | | * '''<font color="red">NOT account-specific, support issues</font>''' - Individual situations that desire a response, such as a billing problem, are ''different'' For those, [http://secondlife.com/support visit our Support Portal]. |
| Bug reports created in JIRA are composed of a description of the problem and, if possible, a reproduction. New features are composed of descriptions of the proposed feature and how it should work. Both types of issues then get contributions from other users, such as better or simpler descriptions and reproductions, and popular issues accumulate votes from other users. Programmers in the open source community can attach "patches", changes to the code that fix or implement the issue. These votes, as well as events like [[bug triage]]s, help prioritize the issues. Those which are acknowledged are "imported" into the Lindens' private copy of JIRA.
| |
|
| |
|
| After the issue gets Linden attention, others can still continue to help. Once the changes are completed and awaiting release to the public, the bug is marked as "resolved - fixed internally". When the change has been made available, it is marked "resolved - fixed", and when confirmed to the satisfaction of most users, "closed - fixed".
| | == What's a bug report? == |
|
| |
|
| In addition to "fixed internally" and "fixed", an issue can also be resolved or closed if it appears to be a duplicate of another issue, unreproducible, misfiled, not a bug, incomplete, etc.
| | A description of a bug, shared by you with us. Useful bug reports are: |
|
| |
|
| == Second Life JIRA FAQ == | | * '''<font color="red">Easy-to-follow</font>''' - Ever given driving directions, where you emphasize landmarks to watch for? Bug reports should be like that: they have a sensible order and a friend can follow your steps. |
| | * '''<font color="red">Reproducible</font>''' - Sadly, some bugs are like Bigfoot — hard to find evidence of. But many bugs happen reliably after following a series of steps. Confirm a bug so we can catch it in the wild. |
|
| |
|
| === Caveats === | | == Steps to create a good report == |
| '''<font color=red>The JIRA Issue Tracker is ''not'' for technical support</font>''', so please do '''''not''''' enter issues like:
| |
|
| |
|
| :* "I can't login! Help me!"
| | With that in mind: |
| :* "I keep crashing and want it to stop now!"
| |
| :* "Someone stole my L$"
| |
| :* "The sim I'm in is LAGGIN BAD"
| |
| :* "How do I build a house?"
| |
| :* [https://jira.secondlife.com/secure/QuickSearch.jspa?searchString=misfiled More examples of misfiled issues]
| |
|
| |
|
| '''Entering misfiled issues which ''aren't'' actionable and ''don't'' contain clear instructions (see below for more info) makes it harder for your fellow Residents to use the Issue Tracker.''' If you're looking for personal assistance, please send your message to the right place by [http://secondlife.com/community/support.php contacting Support] (towards the bottom of the page), and be sure to include ''useful details'' to help us help you. | | # '''[http://community.secondlife.com/t5/English-Knowledge-Base/How-to-report-a-bug/ta-p/733545 Read the article]''' about how to submit a bug. |
| | # [https://feedback.secondlife.com Go to our Bug Tracker] |
| | # Write a bug report including: |
| | ## '''Steps to follow''' |
| | ##:In as much detail as possible, describe a sequence of actions that any user can take to cause the problem to occur. If particular conditions are required, such as being in a specific parcel or having particular permissions set for a group role, describe them carefully. Before submitting your report, test your instructions by having someone else follow them to see if they see the problem. Making these instructions simple is good, but completeness is better than simplicity. |
| | ## '''Describe what you expected to happen''' |
| | ##: such as "the object should change to red" or "my avatar should be wearing the shirt" |
| | ## '''Describe what happened instead''' |
| | ##: If you are able to provide pictures, video, or other illustrations in addition to text, even better. |
| | ## '''Attach supporting information''' |
| | ##: If the problem is a viewer crash or a bad interaction with the server (not getting something you should have, or having an effect on the world that you should not have, for example), include the log files from your viewer as attachments. Be sure that you specify as closely as possible the exact time at which the problem occur so that we can find any relevant information in the logs. See [[Finding Log Files]] for how to find them. |
|
| |
|
| Before reporting issues, we recommend you thoroughly search the [http://secondlife.com/community/support.php support resources] first and look for the latest news and status reports on the [http://blog.secondlife.com/ Official Linden Blog].
| | The goal is to '''show developers what you see, so we can see it too, then hunt down and fix the bug'''. |
|
| |
|
| === Bugs & New Features === | | == I'm not a geek and I need help! == |
| * Please read [[Bug_Reporting_101|QA Bug Submission Guidelines]] '''before''' submitting a a bug.
| | Don't worry, everyone was new once. There's lots of discussion on the Bug Tracker where experienced Residents help new bug reporters. |
| * You can also propose new features through JIRA. (JIRA is emerging to succeed the [http://secondlife.com/vote/ Feature Voting Tool] with your help, because it has better search and parallels the way we Lindens internally organize issues. Plus, you can discuss with other Residents.)
| |
|
| |
|
| === User profile === | | == What if Second Life is having a widespread service issue '''right now'''? == |
| * Each JIRA user has a ''profile''. The profile consists of your Username (SL name), Fullname (in our case, also your SL name), and all of the JIRA groups you belong to. For most people, this means "jira-users."
| |
|
| |
|
| * The email address associated with your account shall remain anonymous to other users. The address is not visible or configurable at this time. Direct import of your email address from Second Life's database is currently disabled.
| | Generally, login problems, teleport failures, and such are shown on our '''[http://status.secondlifegrid.net/ Grid Status Reports]''' and since we're already working on it, there's ''no'' need to file a bug report. |
|
| |
|
| * The JIRA profile is not editable because allowing changes would introduce conflicts with your Second Life account. If you wish to edit account information such as your email address, please login to the [https://secondlife.com/account account management page] at secondlife.com.
| | == What if the bug I found is '''really''' serious and shouldn't be shared? == |
|
| |
|
| === Projects and Components ===
| | '''[[Security_issues|Learn about our Security Issues steps]]''' for exploits that compromise real-life identity, destroy content, and other serious issues that need discretion to be fixed ASAP. |
| * ''Projects'' are used to categorize issues into logical groups.
| |
| * ''Components'' are used to specify which part of a system the issue affects. In other words, what is the scope of the problem within a project.
| |
|
| |
|
| {| class="wikitable" border="1"
| | == I reported a bug but it hasn't been fixed! Why? == |
| |+ Projects and Components in JIRA
| |
| ! Viewer (VWR) !! Service (SVC) !! Website (WEB) !! Miscellaneous (MISC) | |
| |- valign="top"
| |
| |
| |
| * Avatar/Character
| |
| * Building (in-world)
| |
| * Chat/IM
| |
| * Crashes
| |
| * Documentation
| |
| * Graphics
| |
| * Internationalization
| |
| * Inventory
| |
| * Land
| |
| * Linden Dollars (L$)
| |
| * Missing Content
| |
| * Performance
| |
| * Permissions
| |
| * Physics
| |
| * Scripting
| |
| * Sound
| |
| * Source Code
| |
| * Stipends
| |
| * User Interface
| |
| * Voice
| |
| |
| |
| * HTTPRequest
| |
| * Internationalization
| |
| * Performance
| |
| * Physics
| |
| * Scripts
| |
| * Simulation
| |
| * Teleport
| |
| * XML-RPC
| |
| |
| |
| * Account summary
| |
| * blog.secondlife.com
| |
| * Developer Directory
| |
| * Events
| |
| * forums.secondlife.com
| |
| * Friends Online
| |
| * Interactive map
| |
| * jira.secondlife.com
| |
| * Land Store
| |
| * lindenlab.com
| |
| * Lindex
| |
| * New account creation
| |
| * Public Data Feeds
| |
| * Public Metrics & Charts
| |
| * secondlife.com
| |
| * teen.secondlife.com
| |
| * wiki.secondlife.com
| |
| |
| |
| * Miscellaneous
| |
| |}
| |
|
| |
|
| ==== Second Life Viewer (VWR) ====
| | We fix many bugs, but it's unrealistic to expect that we'll fix ''all'' of them. Let's look at this closer: |
| Issues pertaining to the Second Life viewer are reported under this project.
| |
|
| |
|
| Examples:
| | * '''What do we know?''' We can't act on bugs that we can't reproduce or don't have enough info about. It's like telling the police a crime happened without evidence. (While bugs aren't criminals, they certainly cause us pain!) |
| * llGetDate() is returning the wrong date Observed at 10:30 PM PDT on March 19, llGetDate() returns 2007-03-20 (Component = Scripting) | | * '''Is it enough of a priority?''' For example, an inventory loss bug that affects many Residents gets a much higher priority than a cosmetic glitch only noticed by a few. |
| * "My avatar clothing is all black after installing a video driver update" (Component = Avatar/Character) | | * '''What are the dependencies?''' Second Life is a complex system and we need to be sure, even if a bug ''seems'' simple, that fixing it won't create more bugs in related areas. |
| * "Objects in my Inventory do not remain sorted in the correct order after logging out and back in again" (Component = Inventory) | |
| * For about 2 weeks "Recent Items" in my Inventory is not "recent Items" anymore. All the folders are open and everything in my inventory is seen. So it is impossible to see which items are recent.
| |
|
| |
|
| ==== Second Life Service (SVC) ==== | | == How do I find out where bugs get fixed? == |
| Issues pertaining to the Second Life service are reported here.
| |
|
| |
|
| Examples:
| | '''[[:Category:Release_Notes|Check the Release Notes]]'''. Each version contains blow-by-blow highlights of what was changed. |
| * "Server performance decreases when several avatars teleport into the region at once" (Component = Performance and/or Teleport)
| |
| * "My scripted objects are not able to talk to the outside world after Second Life grid downtime" (Component = Scripts).
| |
|
| |
|
| ==== Second Life Website (WEB) ==== | | == How do I report abuse on the Bug Tracker? == |
| Issues pertaining to the Second Life website are in this project.
| |
|
| |
|
| Examples:
| | Unproductive discussion is discouraging, rude, and wastes time better spent fixing issues. We don't tolerate behavior like flaming which violates our [[Linden_Lab_Official:Community_Participation_Guidelines|guidelines]] — please report abuse so we can help keep the Bug Tracker a welcome environment! Thank ''you''! |
| * "Wiki prevents login for users with a dash in their name" (Component = wiki.secondlife.com)
| |
| * "jira.secondlife.com always forces me to authenticate even if I save my login information" (Component = jira.secondlife.com).
| |
|
| |
|
| ==== Second Life Miscellaneous (MISC) ====
| | # In the Second Life Viewer (not on the web), select '''Help''' menu > '''Report Abuse'''. |
| Any other type of issue should be reported in the MISC project.
| | # Fill in all the fields. Not all abuse categories apply to the Bug Tracker, but you may see an intolerant comment, for example. |
| | # In the '''Details''' field, link directly to the abusive comment by clicking the link icon that appears when you hover over a comment, or specific issue where the comment is. |
| | #: [[File:Bug_Tracker_comment_permalink.png]] |
| | # Click '''Report Abuse''' and our Bug Tracker admins will check it out shortly. |
|
| |
|
| Example:
| | Depending on the severity of the abuse, the violator may get a warning or be permanently ''banned'' from the Bug Tracker and even all of Second Life. |
| * "The TOS does not allow me to edit the viewer source code" (Component = Miscellaneous)
| |
|
| |
|
| ==== Security Issues -- a.k.a "the missing Fifth Project" ==== | | == Want to know more? == |
| Issues pertaining to the security of Second Life should be emailed to the [mailto:security@lindenlab.com Second Life Security mailing list] rather than posted on jira.secondlife.com. Emailing them directly to Linden Lab helps us keep Second Life secure!
| |
|
| |
|
| See [[security issues]] page for more information about submitting issues and collecting bounties for responsibly reporting valid security issues.
| | After you've learned the essentials of bug reporting, give it some time to digest. Then: |
|
| |
|
| === Searching ===
| | * '''[http://community.secondlife.com/t5/English-Knowledge-Base/How-to-report-a-bug/ta-p/733545 How to report a bug]''' - If your question wasn't answered above, see this. Highlights include: |
| | ** [[Linden_Lab_Official:Community_Participation_Guidelines|Community Participation Guidelines]] |
| | ** [[Bug_Tracker/Status|Resolution statuses]] |
| | * '''[[:Category:Bug Tracker|Visit the Bug Tracker category]]''' - All pages related to the Bug Tracker. |
|
| |
|
| ==== Parameters ====
| | [[Category:Bug Tracker]] |
| * JIRA searching is easy once you know a bit about the parameters you may use.
| |
| * For instructions on searching in JIRA, please visit [http://www.atlassian.com/software/jira/docs/v3.7.1/querysyntax.html JIRA query syntax] and [http://www.atlassian.com/software/jira/docs/v3.7.1/quicksearch.html JIRA quick search].
| |
| | |
| ==== Perform a search ====
| |
| * First, click on the "Find Issues" link at the top of the screen.
| |
| * Next, enter the parameters you wish to search for in the search pane on the left-hand side of the screen.
| |
| * As an example, if I wish to search for issues that have not been resolved containing the word "avatar", I would choose the following parameters:
| |
| ** Project = all projects
| |
| ** Text search = avatar
| |
| ** Resolutions = Unresolved
| |
| * Another sample search would be for any issues that are fixed in the last week in a particular project. For example, I want to find all bugs in the Second Life Viewer project that were resolved between February 1, 2007 and February 14, 2007. I would enter the following parameters:
| |
| ** (Optional: Click the "New" link in the search pane to clear settings from any previous searches)
| |
| ** Project = Second Life Viewer
| |
| ** Resolution = Fixed
| |
| ** Updated After = January 31, 2007
| |
| ** Updated Before = February 15, 2007
| |
| | |
| ==== Saving a search as a Filter ====
| |
| * A search ''filter'' is a saved search that you may share with others.
| |
| * After performing a search as described above, you may save it as a filter by clicking the "Save" link in the Search pane.
| |
| * Name the filter something meaningful, for example "Unresolved avatar bugs in all projects."
| |
| * Now you can access the search and run it at any time by clicking the "Filter" link in the top right-hand side of the page. This saves time and effort, especially if you frequently run the same complex search and want a handy shortcut!
| |
| | |
| == Reporting an issue in JIRA ==
| |
| To report a new feature, or a bug or problem encountered while using Second Life Open Source Viewer or the Second Life Service itself, please log in to [https://jira.secondlife.com jira.secondlife.com].
| |
| | |
| === Determine if the issue has already been submitted ===
| |
| Upon login to JIRA, you will land on the Home page. Here you have access to some global filters which give you access to the most up-to-date information on submitted issues. The preset filters include all unresolved (unfixed or untested) issues within each project. Of course you may create and save your own filters at any time, or simply run a new search. Either way, it is best practice to search for issues you wish to report in several ways before submitting them!
| |
| | |
| If the issue already was submitted, feel free to leave a comment containing supporting information, or if it's a bug, possibly another reproduction for the QA team. The more information we have about a specific issue, the higher chance of a resolution.
| |
| | |
| It can't be emphasized enough that '''searching for existing issues before filing a new one is the most important step in the submission process'''. Issues submitted more than once take time and effort to find and categorize -- and that is time our team could be spending testing issues and fixing problems instead. The same is true for new features already proposed by other Residents, because duplicates dilute votes, making them less effective.
| |
| | |
| === Read the QA Bug Submission Guidelines ===
| |
| Before you submit a bug, be sure you are familiar with our [[Bug_Reporting_101|QA Bug Submission Guidelines]]. Following them ensures our QA team's ability to reproduce the issue and transfer it to our internal tracking system for resolution by the Linden Lab Development Team!
| |
| | |
| === Submitting a bug ===
| |
| To create a new bug in JIRA, do the following:
| |
| * Log in through the link in the upper-right corner (if you haven't already).
| |
| * Click the "Create New Issue" link in the blue navigation bar towards the top of the screen.
| |
| * Select a project that most closely describes the kind of bug you are submitting
| |
| * Select "Bug" as your "Issue Type".
| |
| * Enter a concise yet descriptive summary of the issue
| |
| ** Be careful to omit Resident names or other personally-identifying information if it can be avoided!
| |
| * Select a component that narrows the scope of the bug
| |
| * Describe the environment in which the problem occurs
| |
| ** For example, "Only happens with Mac OS X 10.4.1," or "Seen only with NVIDIA GeForce Go 7800 card," etc.
| |
| * Enter a detailed description of the issue:
| |
| ** Steps to reproduce the bug (how to make the bug happen)
| |
| ** Observed results (what happens when the bug occurs)
| |
| ** Expected results (what behavior you would have expected instead)
| |
| ** Again, be as detailed as possible without including personal information!
| |
| * Finally, click "Create" to create a new bug
| |
| | |
| === Submitting a new feature ===
| |
| The process is similar to submitting a bug, with the following differences:
| |
| | |
| * You select "New Feature" instead of "Bug" as your "Issue Type".
| |
| * Instead of a "reproduction", clearly describe what the desired implementation and functionality of this new feature is. Make sure it hasn't already been done — you can refer to [http://www.slhistory.org/index.php/Release_Notes release notes] for historical context and [http://blog.secondlife.com/ read our blog] to learn more about what we're doing next.
| |
| | |
| For both bugs and new features, feel free to include links to other relevant info for an issue, such as forum and blog posts.
| |
| | |
| === Voting for issues ===
| |
| You can vote for new features and bugs that you wish to see resolved, and [https://jira.secondlife.com/secure/IssueNavigator.jspa?mode=hide&requestId=10071 view all issues by # of votes]. JIRA uses [http://en.wikipedia.org/wiki/Approval_voting approval voting], so you can vote for as many (or few) issues as you'd like, and you get 1 vote per issue.
| |
| | |
| Votes can readily be used as part of our prioritization process. Note that since we need to look at aspects such as feasibility and the time required for implementation, a highly-voted issue isn't necessarily going to be resolved ahead of a lesser-voted, but more doable one.
| |
| | |
| === Return to check on issue status ===
| |
| Linden Lab will review issues submitted to jira.secondlife.com on a regular basis. The engineering team may require additional information from the issue reporter, or other contributors, so reviewing all of your created/commented issues regularly will be useful while email support in JIRA is disabled.
| |
| | |
| Also, when issues are resolved internally the external site will be updated as well, so check your issues for changes on a regular basis.
| |
| | |
| == Issue States ==
| |
| Here is how Linden Lab is using the resolutions:
| |
| | |
| * Open - This is an issue that belongs to the Assignee to resolve. The assignee may fix the issue, or kick the issue back to the reporter by marking it "Resolved" (see below)
| |
| * In Progress - This is how a developer signals to everyone that he/she is working on the issue.
| |
| * Reopened - same as "Open".
| |
| * Resolved - This is an implicit assignment back to the reporter of the issue. It is not closed yet, but rather in a state of limbo that depends on the resolution. It's up to the Reporter to decide whether to reopen an issue, or close it.
| |
| ** Fixed - means that the bug is fixed in a public release of Second Life.
| |
| ** Fixed Internally - means that the bug is fixed in a version of the code that should soon be publicly available.
| |
| ** Won't Fix - means that the assignee doesn't believe this issue should ever be fixed.
| |
| ** Duplicate - means that there's some other issue that describes the same problem/idea.
| |
| ** Needs More Info - this issue lacks information
| |
| ** Cannot Reproduce - we're applying this label pretty liberally. Please provide a detailed description of how to reproduce a problem. Issues that can't be reproduced will eventually be closed.
| |
| ** Misfiled - this issue doesn't belong in this issue tracker.
| |
| * Closed - The final resting place.
| |
| | |
| == How do I help out? ==
| |
| | |
| Glad you asked!
| |
| | |
| === Marking Duplicates ===
| |
| If you notice an newer issue that is a duplicate of an existing issue with a lot more comments, patches, or votes, feel free to choose "Resolve" and choose "Duplicate". But when you do this, please also choose "Link", and then say "This issue duplicates" and enter the main bug number. This lets everyone keep track of which bugs are duplicates of each other, and which bugs are reported more than others. This ensures that bugs that are often reported get the most attention, and also allows the duplicates to be reviewed from one central location, to ensure they are truly duplicates.
| |
| | |
| === Resolving support issues ===
| |
| This one is best left to technically adept users that can spot the difference between a support issue and a bug -- it's not always a simple matter to figure out. You should at most "Resolve" a report that seems to be a support issue. "Resolving" an issue puts the responsibility back on the reporter to provide more information on why the report isn't a support issue, and is indeed a reproducible bug that an entire class of user experiences.
| |
| | |
| === Resolving bugs that you can't reproduce ===
| |
| If you do exactly what they say in the bug, with the same environment, and can't reproduce the bug, you should resolve the bug. Be careful, if a bug is related to graphics rendering, and you do not have the same video card, for example, that is not the same environment and you can't make this determination. Again this is also best left to technically adept users.
| |
| | |
| === Reproducing bugs ===
| |
| This one is very important! If you can create a step-by-step list to reproduce the bug in the bug report, this helps Linden Lab concentrate on bugs that can be verifiably fixed. Unless a bug can be reproduced, it is impossible to know if it has been fixed or not. Do what the bug reporter said they were doing, write a detailed step-by-step list of things you did to cause the bug to happen, and add it to the bug saying that you have successfully reproduced the bug. Such bugs with solid reproductions get higher priority in the development process, and help the Bug Triage Team work more efficiently.
| |
| | |
| == What's the difference between "Fixed Internally" and "Fixed" resolutions? ==
| |
| It's simple:
| |
| | |
| * "Fixed" means the fix is available in the live Second Life release, ''right now''.
| |
| * "Fixed Internally" means the fix has been made within Linden Lab and ''has not'' been released publicly yet. It may need to undergo extra care, like quality assurance, or requires merging from a [http://en.wikipedia.org/wiki/Branching_%28software%29 branch], before being available to you. Think of it as a "We're almost there... coming soon!" notice.
| |
| | |
| == Customizing preferences ==
| |
| If you want to show more issues per page or change the language JIRA's displayed in, [https://jira.secondlife.com/secure/UpdateUserPreferences!default.jspa Update User Preferences] after logging in. (The email options currently have no effect, see [https://jira.secondlife.com/browse/WEB-58 WEB-58] for why.)
| |
| | |
| == Who is WorkingOnIt Linden? ==
| |
| When an issue is being worked on, it may be assigned to "WorkingOnIt Linden" to mark its status. Any Linden has access to the account. See [[User:WorkingOnIt Linden]] for details.
| |
