Jira Guidelines

This is a guide to using Jira effectively for Apache CloudStack development. This is best practices that we want all contributors to Apache CloudStack to follow. If something is unclear, please don't hesitate to ask on the cloudstack-dev mailing list and/or in the #cloudstack-dev IRC channel on Freenode. (However, please don't uncertainty stop you from filing a bug if you have one – better to file a bug and edit later than to drop it on the floor!)

What Requires a (CLOUDSTACK) Jira Ticket?

You should file a Jira ticket for:

• New Features
• Updates to existing features
• Bugs
• Desired new features (wishlist)

Best Practices for Filing a Ticket

First and foremost, put yourself in the place of someone else trying to solve the issue based on information in the Jira ticket alone. That means put as much information as you can into the ticket so that the next person can work the issue without having to follow up. Even if the ticket is for an issue you plan to work yourself, the more information provided, the better.

The information in Jira tickets is not only used to fix a specific bug. It is also used for:

• Release notes
• By users seeking information about issues they've experienced
• By other developers seeking information about issues they're working on

Jira tickets without a comprehensive description (e.g. Summary only with no text in the Description field) are not acceptable.

Assess Priority

Verify Version(s) of CloudStack Affected

If you run into an issue with a CloudStack release, please make sure you note which version of CloudStack is affected by the bug.

Best Practices for Working Jira Tickets

Resolving and Closing Tickets