From 575c18b1545a6ebe061d2820d45803d822a1cd92 Mon Sep 17 00:00:00 2001 From: Adonis Jimenez <271941740+donny-devops@users.noreply.github.com> Date: Sat, 22 Aug 2026 02:53:51 -0400 Subject: [PATCH] Add code review guidelines to SKILL.md This document outlines guidelines for conducting thorough code reviews, focusing on security, code quality, testing, and architecture practices. --- .github/skills/code-review/SKILL.md | 32 +++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/skills/code-review/SKILL.md diff --git a/.github/skills/code-review/SKILL.md b/.github/skills/code-review/SKILL.md new file mode 100644 index 0000000..11b70d5 --- /dev/null +++ b/.github/skills/code-review/SKILL.md @@ -0,0 +1,32 @@ +--- +name: code-review +description: Guidelines for conducting code reviews on pull requests. +--- + +# Code Review Skill + +## Overview +Perform thorough, constructive code reviews focusing on security, code quality, testing, and standard architecture practices. + +## Guidelines + +### 1. Security & Authentication +- Verify that endpoints requiring authentication use appropriate guards/middleware. +- Ensure sensitive configurations load via environment variables rather than hardcoded strings. +- Validate incoming payload schemas to prevent injection vulnerabilities. + +### 2. Code Quality & Architecture +- Ensure type annotations are fully defined across function signatures. +- Keep controller/handler logic thin by delegating business logic to service layers. +- Check for redundant logic or missed modularization opportunities. + +### 3. Testing +- Confirm new features or bug fixes include corresponding unit or integration tests. +- Verify test suites pass without regressions. + +## Review Output Format +Structure review feedback as follows: +- **Summary**: Concise high-level overview. +- **Critical/Blocking**: Security risks, bugs, or breaking changes. +- **Suggestions**: Non-blocking improvements or refactoring advice. +- **Positives**: Notable well-implemented design decisions.