World Wind Issues

From World Wind Wiki

Jump to: navigation, search

Sponsored by Vidahost webhosting and Thermal Degree web design.

World Wind Issues is a JIRA-powered database for World Wind bugs, enhancement requests, and task items. Found a defect in World Wind or want to suggest an improvement? File a report in World Wind Issues.


[edit] Why use World Wind Issues?

[edit] End-users

If you've found a bug in World Wind, you can discuss it in the chat room or on the forums. But developers can't monitor all these places, all the time. To solicit the attention of potential bug fixers, file a report in World Wind Issues. Your report gets a permanent Web page of its own, where anyone can comment on the report, ask questions, and track efforts toward resolving it.

If there's an issue you want to see addressed, add yourself to its "watch list" to get updates by e-mail. You can even vote for it!

[edit] Developers

At any given time, hundreds of people around the world are using World Wind, finding defects in the software, analyzing its source code, or developing their own code modifications. World Wind Issues is a central coordinating point for all these efforts--and for the open source development process that continually forges a better World Wind.

World Wind Issues helps you:

  • Find an outstanding bug or task you can help resolve.
  • Track and organize your development work. With World Wind Issues, project management is easy: split a task into manageable sub-tasks, prioritize work, assign issues to yourself or others, and even draft a tentative schedule. Check the road map for a quick overview of upcoming development activity.
  • Get feedback, advice, and testing help with the issue you're working to resolve. World Wind Issues puts your efforts on the Web, where anyone can offer suggestions, test your code, or begin a collaboration.
  • Track regressions (new bugs introduced by your code). With World Wind Issues, it's easy to see how an issue is linked to a web of other issues.

[edit] The open source community

World Wind Issues isn't just a place for developers or people with bugs to report. As a member of the World Wind community, you can get involved in many ways.

  • Add issues to the database. If World Wind Issues doesn't know about a bug or enhancement request, we can't track it.
  • Improve the quality of reports in the database. Someone might file a report that merely says: "Crash in World Wind." Such a report is virtually useless, because it's vague and can't be reliably reproduced. Ask the reporter for clarification. Adjust the summary of the issue for utility and clarity. Add important information of your own, including links to forum or mailing list discussion, if appropriate. Solicit the advice of developers who can help resolve the issue. If necessary, mark the issue as a duplicate of a more usefully reported issue.
  • Maintain the issue tracking system. Some reports are filed in the wrong product or component locations, where they might gather dust, ignored. Move issues to their proper places, where the right eyes will see them and take action. Also, verify reported issues. Sometimes a bug is only visible on one person's computer. If others can't reliably reproduce the issue, it may be appropriate to resolve it as "Cannot Reproduce."
  • Monitor World Wind Issues. Every day, new issues are filed, handled, and fixed. Get a sense of what's happening with World Wind, and where your help is most needed, by keeping up to date with World Wind Issues.

[edit] How to use Jira to create/update World Wind Issues

Before using Jira to create or update a World Wind Issue, you may want to review this Jira Help Page.

[edit] Creating an Issue

  • on the main World Wind Issues page, either login, or setup an account for yourself and then login
  • on the menu in the top left corner of the page, select "CREATE NEW ISSUE"
  • for Step 1, make sure to select the appropriate Project and Issue Type
  • for Step 2:
    • Summary: enter a concise summary of the Bug, New Feature, Task, or Improvement. The summary is used when Jira sends notification emails about updates to the Issue, so don't make it too long.
    • Priority: this should reflect the overall priority of this Issue, not your personal priority
    • Due Date: you can leave this blank, as it's not currently being used
    • Component/s: if you don't know what to choose, select Unknown. You can select more than one component.
    • Affects Version/s: if you are entering a Bug, select the closest version to the one you are using when you see the Bug. For other Issue Types, if you aren't sure what to select, choose 'Unknown.
    • Fix Version/s: do not select anything for this field, or select Unknown. This field will be used when updating an existing Issue, but doesn't apply when creating an Issue.
    • Assign To: if you are entering the issue in order to track work you are going to be doing, then click on Assign to me. If you are creating the issue to document something that someone else has already agreed to fix or deal with, then you can select their name from the list. If you aren't sure, just leave it as - Automatic -.
    • Environment: enter any information that may be relevant to helping to deal with the issue.
    • Description: enter a complete description for the issue. You may need to repeat/rephrase your Summary text. Start with a statement of the issue. For Bugs, make sure to explain exactly what happens, including any and all error messages. For Bugs, make sure to include the steps you can use to reproduce the bug. Include any additional information that may be relevant to the person who will be dealing with the issue.
    • Keywords: check Issue META-43 to see if there are any relevant keywords that should be included for your issue.
    • When you press the Create button, the Issue will be created, and you'll receive an email. The email subject line will be something like "[WW-JIRA] Created: (XX-nnn) the Summary of your Issue", where "XX" will be ADD, META, or WW(depending on the selection for Project), and "nnn" will be an automatically assigned number.
  • Once the Issue is created, if you want to be notified of updates to the Issue, use the Watch it link at the bottom of the left-hand menu(not necessary if you have assigned the issue to yourself).
  • If you have additional information relevant to the Issue, such as screenshots or a file, use the Attach screenshot to this issue and/or Attach file to this issue links in the left-hand menu.

[edit] Updating an Issue

[edit] End-users

  • Regardless of whether or not you were the one to create an Issue, you can provide updates, by using the links in the left-hand menu:
    • Comment on this issue Use this to provide more information about an Issue, such as further clarifications, responses to comments by others, results of testing a fix, etc.
    • Attach screenshot to this issue Use this to attach a screenshot that helps clarify some aspect of the Issue.
    • Attach file to this issue In some cases it may be appropriate to attach a file to an Issue.

[edit] Developers

  • Once you have been assigned an Issue, the first step is to select the Available Workflow Action Start Progress, which will change the Issue Status to In Progress.
  • While working on the issue, if you want to make updates, use Comment on this issue. Only use Edit this issue to correct typos, etc., or to change the Issue Type, Priority, Component/s, or Affects Version/s.
  • When you have a tested fix or solution to the Issue, if it involves CVS, do a commit, and make sure to include both the Issue number(e.g. WW-123) and the summary.
  • Use Resolve Issue once a fix or solution is implemented, or a decision reached:
    • Resolution: select the appropriate value.
    • Fix Version/s: select the first version that will contain your fix. Do not select CVS HEAD. For example, if 1.3.2 is in Beta testing, and you checkin a fix to CVS HEAD, mark your fix as being for 1.3.3. If 1.3.2 was in Alpha testing, which implies at least one more 'release', for Beta testing, then a checkin to CVS HEAD would be incorporated into 1.3.2beta, so mark the fix version as 1.3.2.
    • Assign To: don't change this.
    • Update comment: may be left blank, however if there is anything relevant to the fix, include it, especially if the fix has impacts such as installer changes, etc.
  • If the resolved Issue requires other changes or work, such as installer changes, create a new Issue, and link it to the current Issue.
  • Once an Issue is known to be fixed or resolved, use Close Issue, and, if appropriate, include a comment.
  • If an Issue has been closed, and it's discovered that it is not fixed/resolved, you can use Reopen Issue. When doing that, you may want to assign the Issue to yourself.

[edit] Other feedback mechanisms

You can use the following resources to report bugs and request features. But because they provide poor tracking capabilities, they are not a substitute for items in World Wind Issues. Use these resources for discussion purposes only, then file items in World Wind Issues. (Search for duplicate issues before you file a report.)

A large number of bugs listed in the following pages are not in World Wind Issues. To see those issues resolved, verify that they still exist, add them to World Wind Issues, then make a note in the pages below, so others don't add them to the tracker.

[edit] Historic issue tracking systems

World Wind previously used SourceForge's issue trackers to track bugs and feature requests. World Wind no longer uses them.

A large number of SourceForge tracker items are not in World Wind Issues. To see those issues resolved, verify that they still exist, add them to World Wind Issues, then make a note in the pages below, so others don't add them to the tracker. (META-11)

Personal tools