All LabKey Server development issues are tracked in our Issues List
. This is an issue tracker running on our own LabKey Server, which all site users are able to read. For general documentation about issue trackers see Issue/Bug Tracking
Using the issue tracker provides a number of benefits.
- Clear ownership of bugs and features.
- Transparency around assignment of features and fixes to specific releases.
- Testing of all new features and fixes is guaranteed and documented.
Issue Life Cycle
The basic life cycle of an issue looks like this:
- An issue is entered into the issue tracking system. Issues may be features (type "to do"), bugs (type "defect"), spec issues, documentation requirements, etc.
- The owner of the new issue evaluates it to determine whether it's valid and correctly assigned. Issues may be reassigned if the initial ownership was incorrect. Issues may be resolved as "Not reproducible", "Won't Fix", or "Duplicate" in some cases.
- The owner of the issue completes the work that is required and commits the change to source control (or makes configuration changes to the system in question, etc), and resolves the issue. If the owner opens the issue to themselves (as is common for features), the owner should assign the resolved bug to someone else to verify and close. No one should ever close a bug that they have fixed.
- The owner of the resolved issue verifies that the work is completed satisfactorily, or that they agree with any "not reproducible" or "won't fix" explanation. If not, the issue can be re-opened to the resolver. If the work is complete, the issue will be closed. Issues should only be reopened if the original bug is not fixed. New or related problems/requests should be opened as new issues.
Guidelines for Issues
- All users, including guests, can read the issue list. Access to opening issues is granted to non-LabKey employees on a very limited basis.
- Include only one defect per opened issue.
- Include clear steps to reproduce the problem, including all necessary input data.
- Indicate both the expected behavior and the actual behavior.
- If an exception is described, include the full stack trace in text form (e.g., copy the text from the log file or the web page, as opposed to a screen shot).
Premium Edition Users
Subscribers to LabKey Premium Editions have similar issue trackers provided on their individual client support portals
. Clients can either open their own issue reports or submit requests in concert with their account manager.