Back to Details

prowler-pr

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

PR Creation Process

PR创建流程

  1. Analyze changes: 
    git diff main...HEAD
    to understand ALL commits
  2. Determine affected components: SDK, API, UI, MCP, Docs
  3. Fill template sections based on changes
  4. Create PR with 
    gh pr create
  1. 分析变更：使用
    git diff main...HEAD
    了解所有提交记录
  2. 确定受影响的组件：SDK、API、UI、MCP、Docs
  3. 根据变更内容填写模板章节
  4. 使用
    gh pr create
    创建PR

PR Template Structure

PR模板结构

markdown
undefined
markdown
undefined

Context

Context

{Why this change? Link issues with 
Fix #XXXX
}
{Why this change? Link issues with 
Fix #XXXX
}

Description

Description

{Summary of changes and dependencies}
{Summary of changes and dependencies}

Steps to review

Steps to review

{How to test/verify the changes}
{How to test/verify the changes}

Checklist

Checklist

<details> <summary><b>Community Checklist</b></summary>
  • This feature/issue is listed in here or roadmap.prowler.com
  • Is it assigned to me, if not, request it via the issue/feature in here or Prowler Community Slack
</details>
<details> <summary><b>Community Checklist</b></summary>
  • This feature/issue is listed in here or roadmap.prowler.com
  • Is it assigned to me, if not, request it via the issue/feature in here or Prowler Community Slack
</details>

SDK/CLI

SDK/CLI

  • Are there new checks included in this PR? Yes / No
    • If so, do we need to update permissions for the provider? Please review this carefully.
  • Are there new checks included in this PR? Yes / No
    • If so, do we need to update permissions for the provider? Please review this carefully.

UI (if applicable)

UI (if applicable)

  • All issue/task requirements work as expected on the UI
  • Screenshots/Video - Mobile (X < 640px)
  • Screenshots/Video - Tablet (640px > X < 1024px)
  • Screenshots/Video - Desktop (X > 1024px)
  • Ensure new entries are added to ui/CHANGELOG.md
  • All issue/task requirements work as expected on the UI
  • Screenshots/Video - Mobile (X < 640px)
  • Screenshots/Video - Tablet (640px > X < 1024px)
  • Screenshots/Video - Desktop (X > 1024px)
  • Ensure new entries are added to ui/CHANGELOG.md

API (if applicable)

API (if applicable)

  • All issue/task requirements work as expected on the API
  • Endpoint response output (if applicable)
  • EXPLAIN ANALYZE output for new/modified queries or indexes (if applicable)
  • Performance test results (if applicable)
  • Any other relevant evidence of the implementation (if applicable)
  • Verify if API specs need to be regenerated.
  • Check if version updates are required.
  • Ensure new entries are added to api/CHANGELOG.md
  • All issue/task requirements work as expected on the API
  • Endpoint response output (if applicable)
  • EXPLAIN ANALYZE output for new/modified queries or indexes (if applicable)
  • Performance test results (if applicable)
  • Any other relevant evidence of the implementation (if applicable)
  • Verify if API specs need to be regenerated.
  • Check if version updates are required.
  • Ensure new entries are added to api/CHANGELOG.md

License

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
undefined
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
undefined

Component-Specific Rules

组件特定规则

ComponentCHANGELOGExtra Checks
SDK
prowler/CHANGELOG.md
New checks → permissions update?
API
api/CHANGELOG.md
API specs, version bump, endpoint output, EXPLAIN ANALYZE, performance
UI
ui/CHANGELOG.md
Screenshots for Mobile/Tablet/Desktop
MCP
mcp_server/CHANGELOG.md
N/A
组件变更日志文件额外检查项
SDK
prowler/CHANGELOG.md
新增检查项 → 是否需要更新权限？
API
api/CHANGELOG.md
API规范、版本升级、端点输出、EXPLAIN ANALYZE、性能测试
UI
ui/CHANGELOG.md
移动端/平板端/桌面端截图
MCP
mcp_server/CHANGELOG.md
无

Commands

常用命令

bash
undefined
bash
undefined

Check current branch status

Check current branch status

git status git log main..HEAD --oneline
git status git log main..HEAD --oneline

View full diff

View full diff

git diff main...HEAD
git diff main...HEAD

Create PR with heredoc for body

Create PR with heredoc for body

gh pr create --title "feat: description" --body "$(cat <<'EOF'
gh pr create --title "feat: description" --body "$(cat <<'EOF'

Context

Context

... EOF )"
... EOF )"

Create draft PR

Create draft PR

gh pr create --draft --title "feat: description"
undefined
gh pr create --draft --title "feat: description"
undefined

Title Conventions

标题规范

Follow conventional commits:
  • feat:
    New feature
  • fix:
    Bug fix
  • docs:
    Documentation
  • chore:
    Maintenance
  • refactor:
    Code restructure
  • test:
    Tests
遵循Conventional Commits规范：
  • feat:
    新功能
  • fix:
    修复Bug
  • docs:
    文档更新
  • chore:
    维护工作
  • refactor:
    代码重构
  • test:
    测试相关

Before Creating PR

创建PR前的检查

  1. ✅ All tests pass locally
  2. ✅ Linting passes (
    make lint
    or component-specific)
  3. ✅ CHANGELOG updated (if applicable)
  4. ✅ Branch is up to date with main
  5. ✅ Commits are clean and descriptive
  1. ✅ 所有测试在本地运行通过
  2. ✅ 代码检查通过（
    make lint
    或组件特定的检查命令）
  3. ✅ 已更新CHANGELOG（如适用）
  4. ✅ 当前分支已与main分支同步
  5. ✅ 提交记录清晰且描述准确

Resources

参考资源

  • Documentation: See references/ for links to local developer guide
  • 文档：查看references/获取本地开发者指南的链接