Skip to content

Commit 8339ca5

Browse files
committed
chore: add issue templates
1 parent 953472a commit 8339ca5

File tree

4 files changed

+99
-0
lines changed

4 files changed

+99
-0
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Add a new compliance check
3+
about: Use it when you want to work in a new compliance check
4+
title: 'Add Compliance check:'
5+
labels: compliance-checks
6+
assignees: UlisesGascon
7+
8+
---
9+
10+
### How the Check Works
11+
12+
_Provide a clear definition_
13+
14+
15+
### Pending Tasks
16+
- [ ] **1. Define a Good Implementation**
17+
- [ ] Read the documentation (guidelines, best practices...)
18+
- [ ] Brainstorm how to implement this check.
19+
- [ ] Achieve an agreement on the implementation details before starting to work on this.
20+
- [ ] **2. Update Check Record**
21+
- [ ] Update the `compliance_checks` row with the following fields: `how_to_url`, `implementation_status`, `implementation_type` and `implementation_details_reference`
22+
- [ ] Check the migration scripts using `npm run db:migrate` and `npm run db:rollback`
23+
- [ ] Update the database schema by running `npm run db:generate-schema`
24+
- [ ] **3. Implement the Business Logic**
25+
- [ ] Add the alert row in the `compliance_checks_alerts` table.
26+
- [ ] Add the task row in the `compliance_checks_tasks` table.
27+
- [ ] Add the result row in the `compliance_checks_results` table.
28+
- [ ] **4. Ensure It Works as Expected**
29+
- [ ] Add new unit tests for this check.
30+
- [ ] Add new e2e test cases for this check.
31+
- [ ] Verify that all tests are passing.
32+
- [ ] 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`)

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature-request
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/other.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Other
3+
about: Discussions, ideas, etc...
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+

0 commit comments

Comments
 (0)