-
-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Milestone
Description
How the Check Works
Provide a clear definition based on the spreadsheet
Pending Tasks
You can find more details in the contributing guide
- 1. Define a Good Implementation Example
- 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 Example
- Update the
compliance_checksrow with the following fields:how_to_url,implementation_status,implementation_typeandimplementation_details_reference - Check the migration scripts using
npm run db:migrateandnpm run db:rollback - Update the database schema by running
npm run db:generate-schema
- Update the
- 3. Implement the Business Logic Validator Example and Check Example
- 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) - Ensure that the
severityvalue is well calculated (usegetSeverityFromPriorityGroup) - Add the alert row in the
compliance_checks_alertstable when is needed. - Add the task row in the
compliance_checks_taskstable when is needed. - Add the result row in the
compliance_checks_resultstable.
- Add the specific validator in
- 4. Ensure It Works as Expected
- Add new unit tests for the validator check.
- 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 Example
- 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.
- Review the current content it in
Reactions are currently unavailable