Skip to content

Commit

Permalink
readme:code-rabbit-fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanpulver committed Aug 6, 2024
1 parent a51c4d9 commit 316d935
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
- [2. Log In or Register](#2-log-in-or-register)
- [3. Running Your First Scan](#3-running-your-first-scan)
- [Basic Commands](#basic-commands)
- [Service Level Agreement (SLA)](#service-level-agreement-sla)
- [Service-Level Agreement (SLA)](#service-level-agreement-sla)
- [Detailed Documentation](#detailed-documentation)
- [License](#license)
- [Supported Python Versions](#supported-python-versions)
Expand Down Expand Up @@ -75,7 +75,7 @@ Leveraging the industry's most comprehensive database of vulnerabilities and mal
- `safety system-scan`: Perform a scan across the entire development machine.
- `safety scan --apply-fixes`: Update vulnerable dependencies.

# Service Level Agreement (SLA)
# Service-Level Agreement (SLA)

We are committed to maintaining a high level of responsiveness and transparency in managing issues reported in our codebases. This SLA outlines our policies and procedures for handling issues to ensure timely resolutions and effective communication with our community.

Expand Down
8 changes: 4 additions & 4 deletions SLA.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Service Level Agreement (SLA) for Issue Management
# Service-Level Agreement (SLA) for Issue Management

We are committed to maintaining a high level of responsiveness and transparency in managing issues reported in our codebases. This SLA outlines our policies and procedures for handling issues to ensure timely resolutions and effective communication with our community.

Expand Down Expand Up @@ -32,11 +32,11 @@ Goals: While we strive to meet these resolution times, they are goals and not ha
* Regular Updates: We strive to provide regular updates on the progress of unresolved issues and keep everyone informed of our progress.

### Escalation Path
* Escalation: If an issue is not addressed within the expected timeframe, users can escalate the matter by tagging the assignee of the issue or contacting Dylan at [email protected].
* Escalation: If an issue is not addressed within the expected timeframe, users can escalate the matter by tagging the assignee of the issue or contacting Dylan at [[email protected]](mailto:[email protected]).

## Labels
To better organize and prioritize issues, we use the following labels:
* bug: Identifies a problem that needs to be fixed.
* bug: Indicates a problem that needs to be resolved.
* considering: Indicates that the issue is under consideration.
* duplicate: Marks issues that have already been reported.
* invalid: Applied to issues that are not valid or relevant.
Expand All @@ -49,7 +49,7 @@ Each label helps us to classify and prioritize issues effectively, ensuring that

## Procedure for Handling New Issues
1. Automated Acknowledgment: Upon issue submission, an automated message is sent to the reporter.
2. First Human Response: Within 24-48 hours, a team member will review the issue and provide initial feedback.
2. First Human Response: Within 2448 hours, a team member will review the issue and provide initial feedback.
3. Triage: Within 72 hours, the issue will be classified into one of the priority levels.
4. Assignment: The issue will be assigned to the appropriate team member or team for resolution.
5. Status Updates: Regular updates will be provided to the reporter, especially at key milestones.
Expand Down

0 comments on commit 316d935

Please sign in to comment.