Service Level Agreement (SLA)
The SLA terms for this style guide are listed below.
Who is supported by this SLA?
This SLA supports developers (both internal and external) who are working on a University of Adelaide website or application. It also supports staff members that use the style guide on their website and users of the University website that come across any defects with the style guide.
Style guide support
The style guide supported is based around the current version of the style guide. The Web and Digital team will support the current major release version.
A major release is defined in the release number e.g. 1.0.0 (the '1' being the major release number). Previous releases will not be supported once there has been a new major.
The global location for styleguide assets will be updated each minor release (at present every 2 weeks) to ensure the latest version of the style guide is available.
For more information surrounding versioning and release numbers, see the SemVer website.
Critical bugs
Under exceptional circumstances, we are able to correct critical bugs by either applying a hotfix to correct the bug, or if the hotfix would result in a breaking change, upon evaluation, we may be able to provide a patched version with the fix. Note: if a breaking change patch is released, the feature which the fix is applied to will require a code update in your application.
A critical style guide bug is defined as something that:
- Renders a site unusable and has no workaround.
- Renders a feature unusable with no workaround.
- Exposes security vulnerabilities.
- A formal complaint has been made to the University with regards to accessibility and the latest version of style guide does not contain the fix needed OR you are unable to update your app to the latest version.
Upgrading to a newer version
Developers looking to move to a newer version of the style guide should refer to the markup changelog. This details changes to markup within the style guide for each version. Any components or menus you currently use, and any layout elements that have changed, you will need to update the markup for in your template files before moving to the latest version of the style guide.
Developers can also refer to the style guide changelog which contains more of a roll up view of what has changed at each release. It defines what stories have been completed and what functionality has been added/altered and any bugs that have been fixed.
Once you are using a major release of the style guide, you should be able to upgrade to the latest version of that major release without having issues, if you are upgrading from a major release to another major release, it is important to check the markup changelog and style guide changelog for any changes that may break the styling or markup of your website/application.
Tracking defects and resolution process
To raise a defect in the style guide, fill out the online request form and ensure the 'Request type' is set to 'Style Guide'.
From there, an Online Consultant, or style guide maintainer will get in touch with you within the next two business days. If the matter is critical (as defined above) please include 'URGENT' in the subject.
Defects will be logged in JIRA and will be prioritised and actioned based on severity. A defect will use one of the following severity classifications (in ascending order): minor, major, blocker and critical.
This agreement will be reviewed annually.