Skip to end of metadata
Go to start of metadata

Introduction and Quick Instructions for Community Members

CollectionSpace uses Atlassian's JIRA tool to keep track of bugs.  This is located at http://issues.collectionspace.org.

To be able to file a bug, you need to sign up for a JIRA account

Before going into the detailed instructions for filing a bug (a recommended read), a quick overview of the most important steps is given here:

  • Search for the bug to make sure it does not exist
  • When creating a bug, the Summary should be concise and descriptive
  • Always note the environment (OS, Browser name and version number, and anything else that might be relevant)
  • In the Description, make sure to write what the error is and the exact steps to reproduce it.

Instructions on reporting a bug

Make sure the bug is not already reported

Before reporting a bug it is necessary to make sure that the bug does not already exist in Jira. This is done by going to http://issues.collectionspace.org, and then searching the existing JIRAs for the bug you have encountered. There are two ways to search in JIRA:

1) Quick Search: In the top right corner of the screen, there is a text field with "QUICK SEARCH:" written in front of it.

To do a Quick Search, simply enter your query (keywords that describe the problem) and hit enter. The Quick Search feature searches the Summary, Description and Comments fields of the JIRAs. Quick Search furthermore includes search for special keywords for finding specific fix for versions, dates, etc..  To read more about this, and Quick Search in general, follow the link for  JIRA Documentation: Quick Search.

After doing a Quick Search the "Find issues" menu will be displayed on the left, and the results on the right, sorted by relevance.

2) Find Issues: In the menu, top left, you can find a link called "FIND ISSUES". Clicking this will bring you to a menu on the left. This menu has a lot of options for narrowing down your search. Most important is the "Project" Select box. If you mark CollectionSpace in this, a blue info box will appear (shown below)

Click on the "Click here" link, to get extended search options specific to Collectionspace. These will greatly help you narrow down your search. The "components" box is especially helpful. Under "Text Search" you will find the Query field, which will allow you to do a text search in the JIRAs.

Login or Create a user

It is necessary to have a JIRA account, to be able to report a bug. If you already have an account, login (if you are not on the front page, there is a link to login in the very top right corner of the page. For instructions on how to sign up for an account, go to this page.

Creating a new bug

Please only complete the fields listed below!

Go to the collectionspace JIRA if you're not already there: http://issues.collectionspace.org. To create a new bug, click the "Create New Bug" from the blue menu line in the top of the page.

Project and Issue Type:

This will bring you to a screen containg two select boxes (see image below). In "Project", you will want to select CollectionSpace. As issue type, select the appropriate type (this will most often be "Bug"). After having selected Project and Issue Type, Click the Next button.

Summary:

Should be a short and precise description of the bug. It should be possible to tell what this bug is about, and where it occurs, from reading the summary alone. This is also the text that will be displayed in the list when searching for issues

Components:

From the list, select the components the bug is related to, to the best of your knowledge. You can select multiple options, by holding down the control button while clicking each option.

Affects Version/s:

Select the version of collectionspace in which you found the bug

Environment:

Enter the environment under which you found the bug (eg. Windows XP, Internet Explorer 7), make sure to include any information which might be relevant to the bug (eg. your screen resolution, special plugins, etc)

Description:

This is the main description of the bug. Make sure to include at least:

  1. A description of the bug.
  2. A very clear step by step description of how to reproduce the bug.
  3. A description of what you expected.
  4. A description of what actually happens.
  5. Screenshots are always helpful, but optional.

Below is an example of a successfully described bug in JIRA:

Attachment:

If there is something (eg. a screenshot), that will help clarify the bug, you can attach it here. If the bug is an odd layout behavior, and especially if it seems to be quite unusual (in your judgement), please attach a screenshot.

CC:

If there is one or several users that should be notified of this bug (on creation, and state altering), type their name/mail here

QA testplans:

If the bug was found in the course of running a test plan, please choose this from the drop-down list. If the test plan is not listed, please include a link to the wiki page for the link in the description.

Subject:

If any of these seem particularly relevant, please select them. Note that you can select multiple values with CTRL-click.

...And you're done

And that's it. The bug has been filed, and will be reviewed and fixed.

Follow up:

Since you will be listed as the author of the bug, you should get notified when any change is made to the bug, including comments by developers or other project staff. You may be asked questions on how to reproduce the issue, or to test a fix. This is a great way to contribute to the project, and be a part of the CollectionSpace community.

Thanks!

Introduction and Quick Instructions for Project Team Members Only

CollectionSpace uses Atlassian's JIRA tool to keep track of bugs.  This is located at http://issues.collectionspace.org.

To be able to file a bug, you need to [sign up for a JIRA account| JIRA sign up instructions]

Before going into the detailed instructions for filing a bug (a recommended read), a quick overview of the most important steps is given here:

  • Search for the bug to make sure it does not exist
  • When creating a bug, the Summary should be concise and descriptive
  • Prioritization should adhere to the following
    • Blocker: security or data integrity risk. (Prevents user from use/access to core feature)
    • Critical: critical handicap in usage/functionality
    • Major: new functionality, handicaps usage/functionality
    • Minor: nice to have, minor disturbance
    • Trivial: trivial stuff

Instructions on reporting a bug

Make sure the bug is not already reported

Before reporting a bug it is necessary to make sure that the bug does not already exist in Jira. This is done by going to http://issues.collectionspace.org, and then searching the existing JIRAs for the bug you have encountered. There are two ways to search in JIRA:

1) Quick Search: In the top right corner of the screen, there is a text field with "QUICK SEARCH:" written in front of it.

To do a Quick Search, simply enter your query (keywords that describe the problem) and hit enter. The Quick Search feature searches the Summary, Description and Comments fields of the JIRAs. Quick Search furthermore includes search for special keywords for finding specific fix for versions, dates, etc..  To read more about this, and Quick Search in general, follow the link for  JIRA Documentation: Quick Search.

After doing a Quick Search the "Find issues" menu will be displayed on the left, and the results on the right, sorted by relevance.

2) Find Issues: In the menu, top left, you can find a link called "FIND ISSUES". Clicking this will bring you to a menu on the left. This menu has a lot of options for narrowing down your search. Most important is the "Project" Select box. If you mark CollectionSpace in this, a blue info box will appear (shown below)

Click on the "Click here" link, to get extended search options specific to Collectionspace. These will greatly help you narrow down your search. The "components" box is especially helpful. Under "Text Search" you will find the Query field, which will allow you to do a text search in the JIRAs.

Login or Create a user

It is necessary to have a JIRA account, to be able to report a bug. If you already have an account, login (if you are not on the front page, there is a link to login in the very top right corner of the page. For instructions on how to sign up for an account, go to this page.

Creating a new bug

Go to the collectionspace JIRA if you're not already there: http://issues.collectionspace.org. To create a new bug, click the "Create New Bug" from the blue menu line in the top of the page.

Project and Issue Type:

This will bring you to a screen containg two select boxes (see image below). In "Project", you will want to select CollectionSpace. As issue type, select the appropriate type (this will most often be "Bug"). After having selected Project and Issue Type, Click the Next button.

Summary:

Should be a short and precise description of the bug. It should be possible to tell what this bug is about, and where it occurs, from reading the summary alone. This is also the text that will be displayed in the list when searching for issues.

Priority:

Set the priority of your bug according to the following definitions:

Blocker:

Issue prevents a user from accessing or using a core feature of the application

Issue causes data loss, or poses a risk to the integrity of a user's data

Issue involves a security vulnerability

Issue very seriously handicaps a user in using a critical feature

For Public Releases any regressed functionality discovered during QA

Critical:

Great handicap in usage/functionality, but not enough to so qualify as blocker

Major:

Issue is new functionality

Issue is a handicap in usage/functionality

Minor:

Issue would be nice to have but doesn't hamper the user

Trivial:

Sunday evening work for the bored developer

Components:

From the list, select the components the bug is related to, to the best of your knowledge. You can select multiple options, by holding down the control button while clicking each option.

Affects Version/s:

Select the version of collectionspace in which you found the bug.

Fix Version/s:

Please select appropriate version this issue could be resolved.

Assignee:

Select the person who would resolve this issue to the best of your knowledge.

Environment:

Enter the environment under which you found the bug (eg. Windows XP, Internet Explorer 7), make sure to include any information which might be relevant to the bug (eg. your screen resolution, special plugins, etc)

Description:

This is the main description of the bug. Make sure to include at least:

  1. A description of the bug.
  2. A very clear step by step description of how to reproduce the bug.
  3. A description of what you expected.
  4. A description of what actually happens.
  5. Screenshots are always helpful, but optional.

Below is an example of a successfully described bug in JIRA:

Original Estimate:

If this bug is going to be assigned to yourself you can enter an estimated time for fixing this issue. Otherwise, please leave blank for the person who is actually going to work on the issue to log their estimates.

Attachment:

If there is something (eg. a screenshot), that will help clarify the bug, you can attach it here. If the bug is an odd layout behavior, and especially if it seems to be quite unusual (in your judgement), please attach a screenshot.

CC:

If there is one or several users that should be notified of this bug (on creation, and state altering), type their name/mail here

QA testplans:

If the bug was found in the course of running a test plan, please choose this from the drop-down list. If the test plan is not listed, please include a link to the wiki page for the link in the description.

Subject:

If any of these seem particularly relevant, please select them. Note that you can select multiple values with CTRL-click.

Task Order:

Leave untouched unless you have assigned bug to yourself.

...And you're done

And that's it. The bug has been filed, and will be reviewed and fixed.

Follow up:

Since you will be listed as the author of the bug, you should get notified when any change is made to the bug, including comments by developers or other project staff. You may be asked questions on how to reproduce the issue, or to test a fix. This is a great way to contribute to the project, and be a part of the CollectionSpace community.

  • Always note the environment (OS, Browser name and version number, and anything else that might be of relevance)
  • In the Description, make sure to write what the error is and the exact steps to reproduce it.
  • No labels