Imported from prowler-cloud/prowler (
skills/prowler-pr/SKILL.md). Install upstream withnpx skills add prowler-cloud/prowler --skill prowler-pr. Copyright stays with the author (Apache-2.0).
Critical Rules
- The default branch is
master(notmain). Patch fixes targetmasterand are backported tov5.X. - ALWAYS build the body from the CURRENT
.github/pull_request_template.md(read it; do not reuse a cached copy). Keep every heading and the License line; fill or delete component sections that do not apply. - PR title MUST pass
^(feat|fix|docs|style|refactor|perf|test|chore|build|ci|revert)(\([^)]+\))?!?: .+(it becomes the squash commit, seeprowler-commit). - Changes in
prowler/,api/,ui/,mcp_server/(or rootuv.lock/pyproject.toml) need a fragment in<component>/changelog.d/(seeprowler-changelog), or theno-changeloglabel when no entry is warranted. - Link issues in Context with
Fix #XXXX(orFixes #XXXX), never in changelog fragments.
PR Creation Process
- Analyze ALL commits:
git log master..HEAD --onelineandgit diff master...HEAD - Determine affected components from paths: SDK (
prowler/), API (api/), UI (ui/), MCP (mcp_server/), Docs (docs/) - Read and fill the template (
cat .github/pull_request_template.md) - Create the PR with
gh pr create --base master
Template Sections (current file)
| Section | What to write |
|---|---|
### Context |
Why the change is needed; Fix #XXXX |
### Description |
Summary of the change and new dependencies |
### Steps to review |
How to verify: commands, scan flags, UI path, test commands |
### Checklist |
Community checklist (collapsed <details>: issue listed/assigned, no duplicate open PR) + general items (tests, docstrings per Google style, backport, README, SDK changelog fragment) |
#### SDK/CLI |
New checks? Yes/No; if yes, do provider permissions need updating? |
#### UI |
Requirements work; npm dependency package-health evidence (maintenance, popularity, vulnerabilities, license, release age); screenshots for Mobile (<640px), Tablet (640-1024px), Desktop (>1024px); ui/changelog.d/ fragment |
#### API |
Requirements work; endpoint output; EXPLAIN ANALYZE for new/modified queries or indexes; performance results; API spec regeneration; version updates; api/changelog.d/ fragment |
#### MCP Server |
Requirements work; mcp_server/changelog.d/ fragment |
### License |
Keep: "By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license." |
Labels That Change PR Behavior
| Label | Effect |
|---|---|
no-changelog |
Skips the changelog gate (pr-check-changelog.yml) |
backport-to-v5.X |
After merge, backport.yml opens the backport PR to v5.X (labels it backport, source gets was-backported) |
no-compliance-check |
Skips the new-check compliance mapping review (pr-check-compliance-mapping.yml, which otherwise adds needs-compliance-review for unmapped new checks) |
has-conflicts |
Added/removed automatically by pr-conflict-checker.yml |
provider/*, component/*, documentation, compliance, ... |
Applied automatically from paths by labeler.yml + .github/labeler.yml; community is added for external authors |
Review ownership: .github/CODEOWNERS assigns every path to @prowler-cloud/engineering.
Commands
git status
git log master..HEAD --oneline
git diff master...HEAD --stat
# Create PR (body from the template, filled)
gh pr create --base master --title "feat(aws): add <check_id> check" --body "$(cat <<'EOF'
### Context
...
EOF
)"
# Draft PR / add labels
gh pr create --draft --base master --title "fix(ui): description"
gh pr edit <number> --add-label no-changelog
# Check CI after pushing
gh pr checks <number>
Before Creating PR
- Tests pass locally for the touched component (
uv run pytest ...,pnpm test:unit, etc.) - Hooks pass:
uv run prek run --files $(git diff --name-only master...HEAD) - Changelog fragment added (or
no-changelogjustified) - Branch is up to date with
master - Commits are clean and descriptive
Before Re-Requesting Review (REQUIRED)
Resolve or respond to every open inline review thread before re-requesting review:
- Agreed + fixed: Commit the change. Reply with the commit hash so the reviewer can verify quickly:
Fixed in
abc1234. - Agreed but deferred: Explain why it's out of scope for this PR and where it's tracked.
- Disagreed: Reply with clear technical reasoning. Do not leave threads silently open.
- Re-request review only after all threads are in a clean state, either resolved or explicitly responded to.
Rule of thumb: A reviewer should never have to wonder "did they see my comment?" when they re-open the PR.
Resources
- Template:
.github/pull_request_template.md - CI gates in depth:
prowler-ciskill - Documentation: See references/ for links to the local developer guide
