Development Processes

From Skyway Wiki

Jump to: navigation, search

Contents

Logging Jira Reports

We log all bugs, improvement requests and feature requests in the Jira instance that is hosted on skywayperspectives.org. http://www.skywayperspectives.org/jira. Please realize that the issue you log needs to be read and understood by the project lead, product manager, developers and quality assurance team. In addition, others who are using the product should be able to search Jira and find the same problem if they are encountering it.


If need to log an issue:


  1. Search Jira for an existing issue that matches your problem or request.
  2. Click "Create New Issue" on the Jira toolbar.
  3. Select the correct project and issue type. If your report will be about Skyway Builder CE or Skyway Builder EE, select the Skyway Builder project. Keep in mind that the Skyway Builder project is public so don't put confidential information in the Jira.
  4. On the Create Issue screen, fill in these fields:
    • Summary - A short meaningful summary of the problem or request.
    • Description - A longer description of the problem including Steps to Reproduce.
    • Priority - Use the ? bubble next to the Priority field to determine the proper priority of your request or bug. Note that in Jira Priority is really a "severity".
    • Components
    • Sub-Components
    • Classification
    • Environment
    • Builder Edition - Enterprise means the problem or request is for an "Enterprise feature" such as Web Services, Security, etc.
    • Affects Version
    • Assignee - Leave this set to -Automatic- unless you are assigning to yourself.
    • Workaround - (if you have one)
  5. Press the "Create Issue" button


Here is a diagram showing how a Jira issue moves through development and QA at Skyway. Media:JiraIssueLifecycle.jpg

Resolving Jira Reports

After you have fixed a problem or implemented a feature it's time to Resolve the Jira Report. The Jira should be resolved just after checking the associated code into CVS.

  1. Click the "Resolve Issue" link on the left side of the Jira report. If you don't see that link, contact the project lead to get permissions granted.
  2. On the "Resolution" tab fill in these fields:
    • Resolution
    • Package - The code package containing the majority of the fix (com.skyway.xxxxx)
    • Dev Actual - The number of hours you worked on the issue (.5, 10, etc).
    • Date Resolved
    • Comment - Explain what you did.
  3. Press the "Resolve Issue" button


Code Reviews

Peer code reviews are held prior to checking code into CVS. They are performed on an as needed basis. Typical scenarios for code reviews are:

  • New contributors
  • Patches sent by community members
  • Complex or critical architectural changes
  • "Check my work" requests from the developer committing the code. Any time you are making a change in an area you are unfamiliar with, it is a good idea to have the feature owner look at your changes.


If you are a new committer or have complex changes in need of a code review, contact the project lead or feature owner to schecdule a code review.


Checking Code into CVS

Every time you commit code to CVS, you must reference a Jira in your check-in comment. For example: 

MOD-9999 - Fixed problem with display text.

If you've fixed something and there is no Jira for it, log one. Check your code in and then tell the project lead that you've fixed a Jira that hasn't properly been targeted. The lead will get the issue assigned and targeted for the release and you can go ahead and resolve it.


Builds

When we are trying to get a milestone build out, we may rebuild several times. The process works like this:

  • You will recieve a notification prior to the build (or rebuild) asking you to get your changes in. At this point, you must coordinate any last minute changes with the build manager. You can request a short extension if you are trying to get something into a build and are close.
  • Make sure ALL Jira's that are in the Build are in the state of Resolved while the build manager is doing the build. He needs to mark them with a build number so everyone knows what is in the build. If you are marking a Jira report as resolved after the time the Build manager starts the build, notify him of the Jira number so he can make sure it is properly labeled.
  • Once the build manager has started the build do not check code into CVS until you receive the build completed notification.
Retrieved from "http://www.skywayperspectives.org/wiki/index.php/Development_Processes"
Personal tools