prowler-commit

Files (1)

• SKILL.md

SKILL.md (first lines)

## Critical Rules

- ALWAYS use conventional-commits format: `type(scope): description`
- ALWAYS keep the first line under 72 characters
- ALWAYS ask for user confirmation before committing
- NEVER be overly specific (avoid counts like "6 subsections", "3 files")
- NEVER include implementation details in the title
- NEVER use `-n` flag unless user explicitly requests it
- NEVER use `git push --force` or `git push -f` (destructive, rewrites history)
- NEVER proactively offer to commit - wait for user to explicitly request it

---

## Commit Format

```
type(scope): concise description

- Key change 1
- Key change 2
- Key change 3
```

### Types

| Type       | Use When                           |
| ---------- | ---------------------------------- |
| `feat`     | New feature or functionality       |
| `fix`      | Bug fix                            |
| `docs`     | Documentation only                 |
| `chore`    | Maintenance, dependencies, configs |
| `refactor` | Code change without feature/fix    |
| `test`     | Adding or updating tests           |
| `perf`     | Performance improvement            |
| `style`    | Formatting, no code change         |

### Scopes

| Scope    | When                          |
| -------- | ----------------------------- |
| `api`    | Changes in `api/`             |
| `ui`     | Changes in `ui/`              |
| `sdk`    | Changes in `prowler/`         |
| `mcp`    | Changes in `mcp_server/`      |
| `skills` | Changes in `skills/`          |
| `ci`     | Changes in `.github/`         |
| `docs`   | Changes in `docs/`            |
| _omit_   | Multiple scopes or root-level |

---

## Good vs Bad Examples

### Title Line

```
# GOOD - Concise and clear
feat(api): add provider connection retry logic
fix(ui): resolve dashboard loading state
chore(skills): add Celery documentation
docs: update installation guide

# BAD - Too specific or verbose
feat(api): add provider connection retry logic with exponential backoff and jitter (3 retries max)
chore(skills): add comprehensive Celery documentation covering 8 topics
fix(ui): fix the bug in dashboard component on line 45
```

### Body (Bullet Points)

```
# GOOD - High-level changes
- Add retry mechanism for failed connections
- Document task composition patterns
- Expand configuration reference

# BAD - Too detailed
- Add retry with max_retries=3, backoff=True, jitter=True
- Add 6 subsections covering chain, group, chord
- Update lines 45-67 in dashboard.tsx
```

---

## Workflow

1. **Analyze changes**

   ```bash
   git status
   git diff --stat HEAD
   git log -3 --oneline  # Check recent commit style
   ```

2. **Draft commit message**
   - Choose appropriate type and scope
   - Write concise title (< 72 chars)
   - Add 2-5 bullet points for significant changes

3. **Present to user for confirmation**
   - Show files to be committed
   - Show proposed message
   - Wait for explicit confirmation

4. **Execute commit**

   ```bash
   git add <files>
   git commit -m "$(cat <<'EOF'
   type(scope): description

   - Change 1
   - Change 2
   EOF
   )"
   ```

---

From vab1997/mecania-assistant, Apache-2.0.

More from vab1997/mecania-assistant