« Back | Index | Next (for administrators only) »

1) Submitting an issue to Savannah for the Project Documentation

Table of Contents

  1. Before Submitting an Issue
  2. Submit a Bug issue
  3. Submit a Task issue
  4. Linking pairs of Issues
  5. Configure the Subject line of the message
  6. Watching an Issue

1.1) Before Submitting an Issue

Should the issue be submitted to Project Documentation?
Always login before reporting an issue
This will ensure that the issue will be recorded with your name as submitter.
  1. Open (in a new window) the Savannah page ATLAS offline
  2. If you are not registered, register first: In the left panel > Login Status: > New User via SSL
    This has to be done only once.
  3. In the left panel   > Login Status: > Login via SSL.
  4. You are back to the original page; choose Documentation   from the long list of ATLAS projects.
On the Documentation page, horizontal top bar Public Areas: you have the choice between submitting a Bug issue or reporting a Task issue. For the instructions below "submit" means both, a first report or an update. You may want to bookmark the submit page for faster future access.

1.2) Submit a Bug issue

On the Submit page, horizontal top bar: click Bugs > Submit a Bug. For updates select Browse ... and then the Item ID.
Only some fields are mandatory. Note also that some fields (Status, Priority, Open/Closed) are only shown when an update to an issue is made. Fields, which are not yet set show None. When you submit an issue all field values should be set except Assigned to, where None will be replaced by a default value depending on the chosen value for Category.
  1. Category: Choose one of
    Standard Web    Standard Web pages for Offline Software 
    Wiki            General Wiki pages and features (e.g. Workbook, navigation panels)
    Doxygen         Doxygen configuration and processing, Doxygen pages of core packages
    Doc in CVS      General software documentation in the CVS repository
    Other           Any other category not listed above
        
  2. Priority: Choose one of
    Trivial, Minor, Major, Critical, Blocker 
  3. Status: Workflow actions or Operations. Choose one of
    Start progress   Work flow  -- Start working on the issue 
    Resolve issue               -- Resolve issue 
    Close issue (+)             -- Close the issue
    
    Assign           Operation -- Assign this issue to another developer 
    Attach file (+)            -- Attach file to this issue
    Comment                    -- Comment on this issue
    Link                       -- Provide link to other issue 
                                  (e.g. see details at 
                                  Linking issues  )
    Other            Any other action not listed above
        
    If several of the choices apply to an issue, choose one of them, e.g. from Work flow. The (+) sign indicates that an additional field has to be set.
  4. Assigned to: Shows the names of the responsibles for Documentation. One person is assigned by default to each Category (unfortunately not shown by Savannah). None will be on Submit automatically replaced by the userID of this person. You may reassign the issue to another person.

  5. Summary: Short description of Bug or Task. Do (normally) not change this line when submitting an update.

  6. Report: provide information which describes the task or may be needed to reproduce the Bug.

  7. You may attach a file. Its size is limited to 512 KBytes. Where reasonable provide a URL instead.

  8. Mail notification: Normally the default setting should be sufficient (will be atlas-sw-sit@cern.ch).

1.3) Submit a Task issue

In the horizontal top bar click on Task > Submit a Task.
Task reports are similar to Bug reports. The only difference is the additional field of Item group. The mandatory fields are Item Group, Priority, and Summary. Ignore the fields Should start , Should be finished.
  1. Item group
    Task             Tracking a Task (e.g. started working on Chapter/Section) 
    New Feature      Request not yet existing Feature  
    Improvement      Modify existing Feature      
       

1.4) Linking pairs of Issues

To link an issue (source) to another issue (target), insert in the source description the Identifier TTT#xxxx. TTT is the tracking type (Bug, Task) and xxxx is the target issue-number. TTT is case independent and a space is allowed between TTT and #, but not between # and xxxx. Valid and equivalent identifiers are Bug#1234, Bug #1234, bug#1234. The Identifier becomes clickable once the source description is submitted. Linking can be done between any projects and any issues.

1.5) Configure the Subject line of the message

The subject line of the message can be configured to show the Project and the Issue Identifier.
  1. Login; in the left Panel > Logged in as yourLogin > My account Conf
  2. In the Preferences (right panel) > Edit Personal Notification Settings
  3. At the bottom of the Account Configuration page set Subject Line to
      %Project %Tracker %Item
  4. Click Update

1.6 Watching an Issue

You may want to get informed about changes to an issue even when you have not signed up to receive messages in general. To watch an issue, go to the page of this issue and enter your Savannah login name or e-mail address in the field Mail Notification Carbon-Copy List and submit the form.
« Back | Index | Next (for administrators only) »