-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Adds bug severity guidelines (#32)
* feat: adds-bug-severity-guidelines * fix: index and initial paragraph * fix: remove some text * fix
- Loading branch information
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Bug Severity | ||
|
||
- [Purpose](#purpose) | ||
- [Critical](#critical) | ||
- [High Severity](#high-severity) | ||
- [Medium Severity](#medium-severity) | ||
- [Low Severity](#low-severity) | ||
|
||
## Purpose | ||
|
||
This policy outlines the criteria for classifying the severity of bugs identified by the Catalyst Team. Once a bug report is submitted, the appropriate severity level should be assigned in collaboration with the relevant stakeholders. For critical or high-severity bugs, the issue should be raised and discussed during the daily meeting. | ||
|
||
## Critical | ||
|
||
A **critical bug** is a defect in a software application that causes a complete failure or breakdown of the system, significantly affecting its core functionality, security, or stability. Critical bugs typically require immediate attention and resolution because they can lead to severe consequences, such as system crashes, data loss, or serious security vulnerabilities. | ||
|
||
Examples of critical bugs include: | ||
|
||
1. **System crashes or hangs** – Bugs that cause the application or the entire system to crash, freeze, or become unresponsive, making it completely unusable for the end user. | ||
2. **Data corruption or loss** – Bugs that lead to the loss or corruption of important data, such as user information, transactions, or files, can result in serious consequences for both the user and the organization. | ||
3. **Security vulnerabilities** – Bugs that expose the application or system to attacks, such as SQL injection, cross-site scripting (XSS), or unauthorized access, which could compromise sensitive data or lead to a breach. | ||
4. **Inability to perform critical functions** – A bug that disables core functions of the software, such as a payment processing system failing during a transaction, or login functionality being broken, prevents users from completing vital actions. | ||
|
||
## High Severity | ||
|
||
A **high-priority bug** is an issue that significantly affects the functionality, usability, or performance of a system but does not necessarily cause a complete failure. | ||
|
||
Examples of high-priority bugs include: | ||
|
||
1. **Key features that are broken** – When a core feature, such as a payment gateway, user authentication, or data retrieval, is not working properly, it can prevent users from completing tasks and cause significant interruptions to service. | ||
2. **Performance degradation** – A bug that causes slow response times or lag, particularly in critical workflows, can make the system unusable for users, even if it doesn’t cause a full crash. | ||
3. **Data inconsistencies or errors** – Bugs that cause inaccurate data to be displayed or processed, especially in business-critical applications, can undermine trust and lead to poor decision-making. | ||
4. **Cross-platform issues** – Bugs that impact how a system behaves on certain devices or browsers, especially if the system is intended to work across a wide range of platforms, can prevent a significant portion of users from accessing the service properly. | ||
|
||
|
||
## Medium Severity | ||
|
||
A **medium-severity bug** is an issue that affects the functionality or usability of a system but does not cause a critical failure or severely disrupt the user experience. | ||
|
||
Examples of medium-severity bugs include: | ||
|
||
1. **Minor UI/UX issues** – Problems like misaligned elements, broken links, or confusing navigation that affect the aesthetic or ease of use but don’t prevent users from using the software effectively. | ||
2. **Partial functionality failures** – Features that don’t work as expected but still allow the user to continue interacting with the system (for example, a search function that returns incorrect results but doesn’t prevent the user from browsing the application). | ||
3. **Performance issues** – Slower load times or performance degradation in certain non-critical areas that don’t render the system unusable but can detract from the overall user experience. | ||
4. **Inconsistent behavior** – Features that work differently in some cases but are still functional, such as a button not responding on one browser but working fine on another. | ||
|
||
## Low Severity | ||
|
||
A **low-severity bug** is an issue in the software that has minimal impact on the functionality or user experience. | ||
|
||
Examples of low-severity bugs include: | ||
|
||
1. **Cosmetic issues** – Minor visual flaws such as incorrect fonts, colors, or alignment problems that don't affect the user’s ability to interact with the software or complete tasks. | ||
2. **Typos or grammatical errors** – Small text mistakes in UI elements, messages, or instructions that may affect professionalism but do not hinder functionality. | ||
3. **Non-critical feature glitches** – Features that behave incorrectly but have little to no effect on the user’s ability to complete important actions (for example, a non-functioning tooltip or a small, non-essential option not displaying correctly). | ||
4. **Minor compatibility issues** – Occasional glitches on specific devices or browsers that don’t affect most users and don’t interfere with key functionality. |