Skip to content

Commit

Permalink
docs: add examples to the issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
UlisesGascon committed Dec 7, 2024
1 parent c4778a2 commit ab5a5e9
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions .github/ISSUE_TEMPLATE/add-a-new-compliance-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,18 @@ _Provide a clear definition_


### Pending Tasks
- [ ] **1. Define a Good Implementation**

You can find more details in [the contributing guide](/CONTRIBUTING.md#current-initiatives)

- [ ] **1. Define a Good Implementation [Example](https://github.com/secure-dashboards/openjs-foundation-dashboard/issues/43#issuecomment-2524594504)**
- [ ] Read the documentation (guidelines, best practices...)
- [ ] Brainstorm how to implement this check (logic, alerts, tasks, validations, edge cases...).
- [ ] Achieve an agreement on the implementation details before starting to work on this.
- [ ] **2. Update Check Record**
- [ ] **2. Update Check Record [Example](https://github.com/secure-dashboards/openjs-foundation-dashboard/commit/55eaac59920a5229ef9eeaf859943578a66d1aeb)**
- [ ] 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**
- [ ] **3. Implement the Business Logic [Validator Example](https://github.com/secure-dashboards/openjs-foundation-dashboard/commit/44c41d119f0daefb7b2e496ba35d5ab65bcc319b) and [Check Example](https://github.com/secure-dashboards/openjs-foundation-dashboard/commit/6f1e16129ee0d01a1b9b536cd2dc6090b048b71f)**
- [ ] Add the specific validator in `src/checks/validators/index.js`
- [ ] Add the check logic in `src/checks/complianceChecks`
- [ ] Ensure that the check is in scope for the organization (use `isCheckApplicableToProjectCategory`)
Expand All @@ -34,6 +37,6 @@ _Provide a clear definition_
- [ ] Add new integration 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`)
- [ ] **5. Update the website**
- [ ] **5. Update the website [Example](https://github.com/secure-dashboards/openjs-security-program-standards/pull/9)**
- [ ] Review the current content it in `https://openjs-security-program-standards.netlify.app/details/{check_code_name}`
- [ ] Create a PR in https://github.com/secure-dashboards/openjs-security-program-standards to include how we calculate this check and include additional information on the mitigation if needed.

0 comments on commit ab5a5e9

Please sign in to comment.