diff --git a/overriding-rules.md b/overriding-rules.md index af445cc..a6744f9 100644 --- a/overriding-rules.md +++ b/overriding-rules.md @@ -1,15 +1,15 @@ -# Overriding Review Rules +# ⚙️ Overriding Review Rules -## Introduction +## 📌 Introduction This section describes the basic principles of redefining the built-in prompt of the tool. This can be used to create your own rules during review. > **Be careful** — when you override the rules, you override the **entire prompt**, including all review logic, output format, and tool permissions. > ⚠️ **Important!** When you override settings, you must override **all** settings at once: the prompt, allowed tools, and disallowed tools. You do this by specifying the `options_type` parameter in the Gitea action. -## Override Methods - Select one of the options from the list below +## 🔀 Override Methods - Select one of the options from the list below -### Method 1: Overriding via a folder +### 📁 Method 1: Overriding via a folder Set the `options_type` parameter to `"folder"` and create a `.review/` folder in your repository with these 3 files: @@ -50,13 +50,13 @@ jobs: Take a look at this example of custom settings for a specific domain; use it as an exemple for creating your own settings: -- [Technical Writing & Documentation Review](review-template-tech-writer) — grammar, clarity, structure, and content quality for docs and articles -- [Security Review](review-template-security) — vulnerabilities, unsafe patterns, OWASP Top 10, secrets exposure -- [Performance Review](review-template-performance) — bottlenecks, N+1 queries, memory leaks, algorithmic complexity +- 📝 [Technical Writing & Documentation Review](review-template-tech-writer) — grammar, clarity, structure, and content quality for docs and articles +- 🔒 [Security Review](review-template-security) — vulnerabilities, unsafe patterns, OWASP Top 10, secrets exposure +- ⚡ [Performance Review](review-template-performance) — bottlenecks, N+1 queries, memory leaks, algorithmic complexity Each template page contains a ready-to-use prompt, allowed tools list, and disallowed tools list, along with usage examples for both override methods. -### Method 2: Overriding via script arguments +### 📋 Method 2: Overriding via script arguments Set the `options_type` parameter to `"arguments"` and pass the following three parameters directly in the action: @@ -98,15 +98,15 @@ Replace the values of `cc_prompt`, `cc_allowed_tool`, and `cc_disallowed_tool` w Take a look at this example of custom settings for a specific domain; use it as an exemple for creating your own settings: -- [Technical Writing & Documentation Review](review-template-tech-writer) — grammar, clarity, structure, and content quality for docs and articles -- [Security Review](review-template-security) — vulnerabilities, unsafe patterns, OWASP Top 10, secrets exposure -- [Performance Review](review-template-performance) — bottlenecks, N+1 queries, memory leaks, algorithmic complexity +- 📝 [Technical Writing & Documentation Review](review-template-tech-writer) — grammar, clarity, structure, and content quality for docs and articles +- 🔒 [Security Review](review-template-security) — vulnerabilities, unsafe patterns, OWASP Top 10, secrets exposure +- ⚡ [Performance Review](review-template-performance) — bottlenecks, N+1 queries, memory leaks, algorithmic complexity Each template page contains a ready-to-use prompt, allowed tools list, and disallowed tools list, along with usage examples for both override methods. -### Important Limitations +### ⚠️ Important Limitations -#### Value for the `cc_allowed_tool` parameter and the `ALLOWED_TOOLS.md` file +#### ✅ Value for the `cc_allowed_tool` parameter and the `ALLOWED_TOOLS.md` file The list of allowed tools must always include the following: @@ -116,7 +116,7 @@ Bash, Edit, MultiEdit, Glob, Grep, LS, Read, Write, mcp__serena, mcp__gitea__get You can expand it by adding your own, but we do not recommend removing anything from it. -#### Value for the `cc_disallowed_tool` parameter and the `DISALLOWED_TOOLS.md` file +#### ✅ Value for the `cc_disallowed_tool` parameter and the `DISALLOWED_TOOLS.md` file The list of disallowed tools must always include the following: diff --git a/review-template-performance.md b/review-template-performance.md index 7db6091..b7078b7 100644 --- a/review-template-performance.md +++ b/review-template-performance.md @@ -1,10 +1,10 @@ -# Review Template: Performance Review +# ⚡ Review Template: Performance Review This template is designed for performance-focused code review. The AI agent will prioritize identifying bottlenecks, inefficient algorithms, unnecessary resource usage, and scalability concerns. --- -## Prompt (`cc_prompt` / `PROMPT.md`) +## 🤖 Prompt (`cc_prompt` / `PROMPT.md`) ``` # Context Description @@ -119,20 +119,20 @@ Use `REQUEST_CHANGES` if critical performance issues were found, `APPROVED` if o --- -## Allowed Tools (`cc_allowed_tool` / `ALLOWED_TOOLS.md`) +## ✅ Allowed Tools (`cc_allowed_tool` / `ALLOWED_TOOLS.md`) ``` Bash, Edit, MultiEdit, Glob, Grep, LS, Read, Write, mcp__serena, mcp__gitea__get_pull_request_by_index, mcp__gitea__list_repo_pull_requests, mcp__gitea__list_repo_commits, mcp__gitea__create_pull_request_review, mcp__gitea__get_pull_request_review, mcp__gitea__list_pull_request_reviews, mcp__gitea__delete_pull_request_review, mcp__gitea__dismiss_pull_request_review, mcp__gitea__submit_pull_request_review, mcp__gitea__get_issue_by_index, mcp__gitea__list_pull_request_review_comments, mcp__gitea__get_file_content, mcp__gitea__create_issue, mcp__gitea__get_dir_content, mcp__gitea__edit_issue, mcp__gitea__get_issue_comments_by_index, mcp__gitea__create_issue_comment ``` -> The list above is the recommended baseline. You may extend it with additional tools specific to your setup. +> 💡 The list above is the recommended baseline. You may extend it with additional tools specific to your setup. --- -## Disallowed Tools (`cc_disallowed_tool` / `DISALLOWED_TOOLS.md`) +## 🚫 Disallowed Tools (`cc_disallowed_tool` / `DISALLOWED_TOOLS.md`) ``` WebSearch, Bash(git diff:*), Bash(git push:*), Bash(rm:*), Bash(git diff:*) ``` -> The list above is the recommended baseline. You may extend it with additional restrictions as needed. +> 💡 The list above is the recommended baseline. You may extend it with additional restrictions as needed. \ No newline at end of file diff --git a/review-template-security.md b/review-template-security.md index 2b61602..9001f86 100644 --- a/review-template-security.md +++ b/review-template-security.md @@ -1,10 +1,10 @@ -# Review Template: Security Review +# 🔒 Review Template: Security Review This template is designed for security-focused code review. The AI agent will prioritize identifying vulnerabilities, unsafe patterns, and security risks in the submitted code changes. --- -## Prompt (`cc_prompt` / `PROMPT.md`) +## 🤖 Prompt (`cc_prompt` / `PROMPT.md`) ``` # Context Description @@ -118,20 +118,20 @@ Use `REQUEST_CHANGES` if any security issues were found, `APPROVED` only if no s --- -## Allowed Tools (`cc_allowed_tool` / `ALLOWED_TOOLS.md`) +## ✅ Allowed Tools (`cc_allowed_tool` / `ALLOWED_TOOLS.md`) ``` Bash, Edit, MultiEdit, Glob, Grep, LS, Read, Write, mcp__serena, mcp__gitea__get_pull_request_by_index, mcp__gitea__list_repo_pull_requests, mcp__gitea__list_repo_commits, mcp__gitea__create_pull_request_review, mcp__gitea__get_pull_request_review, mcp__gitea__list_pull_request_reviews, mcp__gitea__delete_pull_request_review, mcp__gitea__dismiss_pull_request_review, mcp__gitea__submit_pull_request_review, mcp__gitea__get_issue_by_index, mcp__gitea__list_pull_request_review_comments, mcp__gitea__get_file_content, mcp__gitea__create_issue, mcp__gitea__get_dir_content, mcp__gitea__edit_issue, mcp__gitea__get_issue_comments_by_index, mcp__gitea__create_issue_comment ``` -> The list above is the recommended baseline. You may extend it with additional tools specific to your setup. +> 💡 The list above is the recommended baseline. You may extend it with additional tools specific to your setup. --- -## Disallowed Tools (`cc_disallowed_tool` / `DISALLOWED_TOOLS.md`) +## 🚫 Disallowed Tools (`cc_disallowed_tool` / `DISALLOWED_TOOLS.md`) ``` WebSearch, Bash(git diff:*), Bash(git push:*), Bash(rm:*), Bash(git diff:*) ``` -> The list above is the recommended baseline. You may extend it with additional restrictions as needed. +> 💡 The list above is the recommended baseline. You may extend it with additional restrictions as needed. \ No newline at end of file diff --git a/review-template-tech-writer.md b/review-template-tech-writer.md index faa172e..f36e4f6 100644 --- a/review-template-tech-writer.md +++ b/review-template-tech-writer.md @@ -1,10 +1,10 @@ -# Review Template: Technical Writing & Documentation +# 📝 Review Template: Technical Writing & Documentation This template is designed for reviewing documentation, articles, changelogs, and other technical writing. The AI agent will focus on grammar, clarity, structure, and content quality rather than code. --- -## Prompt (`cc_prompt` / `PROMPT.md`) +## 🤖 Prompt (`cc_prompt` / `PROMPT.md`) ``` # Context Description @@ -92,20 +92,21 @@ Call `create_pull_request_review` with owner, repo, index, body, comments, and s ``` --- -## Allowed Tools (`cc_allowed_tool` / `ALLOWED_TOOLS.md`) + +## ✅ Allowed Tools (`cc_allowed_tool` / `ALLOWED_TOOLS.md`) ``` Bash, Edit, MultiEdit, Glob, Grep, LS, Read, Write, mcp__serena, mcp__gitea__get_pull_request_by_index, mcp__gitea__list_repo_pull_requests, mcp__gitea__list_repo_commits, mcp__gitea__create_pull_request_review, mcp__gitea__get_pull_request_review, mcp__gitea__list_pull_request_reviews, mcp__gitea__delete_pull_request_review, mcp__gitea__dismiss_pull_request_review, mcp__gitea__submit_pull_request_review, mcp__gitea__get_issue_by_index, mcp__gitea__list_pull_request_review_comments, mcp__gitea__get_file_content, mcp__gitea__create_issue, mcp__gitea__get_dir_content, mcp__gitea__edit_issue, mcp__gitea__get_issue_comments_by_index, mcp__gitea__create_issue_comment ``` -> The list above is the recommended baseline. You may extend it with additional tools specific to your setup. +> 💡 The list above is the recommended baseline. You may extend it with additional tools specific to your setup. --- -## Disallowed Tools (`cc_disallowed_tool` / `DISALLOWED_TOOLS.md`) +## 🚫 Disallowed Tools (`cc_disallowed_tool` / `DISALLOWED_TOOLS.md`) ``` WebSearch, Bash(git diff:*), Bash(git push:*), Bash(rm:*), Bash(git diff:*) ``` -> The list above is the recommended baseline. You may extend it with additional restrictions as needed. +> 💡 The list above is the recommended baseline. You may extend it with additional restrictions as needed.