Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
UlisesGascon authored Dec 6, 2024
1 parent 47a72b9 commit 88edf04
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 10 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/add-a-new-compliance-check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Add a new compliance check
about: Use it when you want to work in a new compliance check
title: 'Add Compliance check:'
labels: compliance-checks
assignees: UlisesGascon

---

### How the Check Works

_Provide a clear definition_

### Pending Tasks
- [ ] **1. Define a Good Implementation**
- [ ] Brainstorm how to implement this check.
- [ ] Achieve an agreement on the implementation details before starting to work on this.
- [ ] **2. Update Check Record**
- [ ] Update the `compliance_checks` row with the following fields: `how_to_url`, `implementation_status`, `implementation_type` and `implementation_details_reference`
- [ ] Check the migration scripts using `npm run db:migrate` and `npm run db:rollback`
- [ ] Update the database schema by running `npm run db:generate-schema`
- [ ] **3. Implement the Business Logic**
- [ ] Add the alert row in the `compliance_checks_alerts` table.
- [ ] Add the task row in the `compliance_checks_tasks` table.
- [ ] Add the result row in the `compliance_checks_results` table.
- [ ] **4. Ensure It Works as Expected**
- [ ] Add new test cases for this check.
- [ ] Verify that all tests are passing.
- [ ] Run the command `check run --name {check_code_name}` and verify the changes in the database. Update the seed script if needed (`npm run db:seed`)
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

0 comments on commit 88edf04

Please sign in to comment.