Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

fai-git-commit-best-practices

/fai-git-commit-best-practices

Pisze komunikaty commitów w konwencji conventional commits z sensownym zakresem, treścią i stopką, dla czystej historii gita, z konfiguracją commitlint i semantic-release.

Repozytorium
frootai ↗
Licencja
MIT
Ostatnia zmiana repozytorium
26.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
3
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 26.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Pisze komunikaty commitów w konwencji conventional commits z sensownym zakresem, treścią i stopką, dla czystej historii gita, z konfiguracją commitlint i semantic-release.

Wyzwalacze z opisu

commit this
Oryginalny opis (EN)

Write conventional-commit messages with meaningful scope, body, and footer for clean, automatable git history. Use this skill when committing changes, preparing a PR, or configuring commitlint/semantic-release — even if the user just says "commit this" or asks how to phrase a commit.

Jak działa

  1. Overview
  2. Parameters
  3. Steps
  4. Output
  5. WAF Alignment
  6. Error Handling
  7. Usage
  8. Configuration Reference
  9. Monitoring
  10. Troubleshooting
Sekcje z nagłówków SKILL.md, w oryginale · 153 linii, 659 słów
Podgląd SKILL.md
---
name: fai-git-commit-best-practices
description: Write conventional-commit messages with meaningful scope, body, and footer for clean, automatable git history. Use this skill when committing changes, preparing a PR, or configuring commitlint/semantic-release — even if the user just says "commit this" or asks how to phrase a commit.
---

# Fai Git Commit Best Practices

Guides best practices for git commits — atomic changes, descriptive messages, signed commits.

## Overview

This skill provides a structured, repeatable procedure for guides best practices for git commits — atomic changes, descriptive messages, signed commits.. It can be used standalone as a LEGO block or auto-wired inside solution plays via the FAI Protocol.

**Category:** General
**Complexity:** Medium
**Estimated Time:** 10-30 minutes

## Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `target` | string | Yes | — | Target resource, file, or endpoint |
| `environment` | enum | No | `dev` | Target environment: `dev`, `staging`, `prod` |
| `verbose` | boolean | No | `false` | Enable detailed output logging |
| `dry_run` | boolean | No | `false` | Validate without making changes |
| `config_path` | string | No | `config/` | Path to configuration directory |

## Steps

### Step 1: Validate Prerequisites

Verify all required tools, credentials, and dependencies are available.

```bash
# Check required tools
command -v node >/dev/null 2>&1 || { echo 'Node.js required'; exit 1; }
command -v az >/dev/null 2>&1 || { echo 'Azure CLI required'; exit 1; }
```

### Step 2: Load Configuration

Read settings from the FAI manifest and TuneKit config files.

```bash
# Load from fai-manifest.json if inside a play
CONFIG_DIR="${config_path:-config}"
if [ -f "fai-manifest.json" ]; then
  echo "FAI Protocol detected — auto-wiring context"
fi
```

### Step 3: Execute Core Logic

Perform the primary operation: guides best practices for git commits — atomic changes, descriptive messages, signed commits..

### Step 4: Validate Results

Verify the output meets quality thresholds and WAF compliance.

```bash
# Validate output
if [ "$?" -eq 0 ]; then
  echo "✅ Skill completed successfully"
else
  echo "❌ Skill failed — check logs"
  exit 1
fi
```

## Output

| Output | Type | Description |
|--------|------|-------------|
| `status` | enum | `success`, `warning`, `failure` |
| `duration_ms` | number | Execution time in milliseconds |
| `artifacts` | string[] | List of generated/modified files |
| `logs` | string | Detailed execution log |

## WAF Alignment

| Pillar | How This Skill Contributes |
|--------|---------------------------|
| reliability | Includes retry logic, validates outputs, provides rollback steps |
| operational-excellence | Produces structured logs, integrates with CI/CD, follows IaC patterns |

## Error Handling

| Exit Code | Meaning | Action |
|-----------|---------|--------|
| 0 | Success | Proceed to next step |
| 1 | Validation failure | Check input parameters |
| 2 | Dependency missing | Install required tools |
| 3 | Runtime error | Check logs, retry with `--verbose` |

## Usage

### Standalone

```bash
# Run this skill directly
npx frootai skill run fai-git-commit-best-practices
```

### Inside a Solution Play

When referenced in `fai-manifest.json`, this skill auto-wires with the play's context:

```json
{
  "primitives": {
    "skills": ["skills/fai-git-commit-best-practices/"]
  }
}
```

### Via Agent Invocation

Agents can invoke this skill using the `/skill` command in Copilot Chat.

## Configuration Reference

```json
{
  "skill": "skill-name",
  "version": "1.0.0",
  "timeout_seconds": 300,
  "retry_attempts": 3,
  "log_level": "info"
}
```

## Monitoring

Track skill execution metrics:

| Metric | Description | Alert Threshold |
|--------|-------------|----------------|
| Duration | Execution time | > 60 seconds |
| Success rate | Pass/fail ratio | < 95% |
| Error count | Failed executions | > 5/hour |

## Troubleshooting

| Symptom | Cause | Fix |
|---------|-------|-----|
| Timeout | Slow dependency | Increase timeout_seconds |
| Auth failure | Expired credentials | Refresh Managed Identity |
| Missing config | No fai-manifest.json | Create manifest or pass config_path |
| Validation error | Invalid input | Check parameter types and ranges |

## Notes

- This skill follows the FAI SKILL.md specification
- All outputs are deterministic when `dry_run=true`
- Integrates with FAI Engine for automated pipeline execution
- Part of the General category in the FAI primitives catalog
Pliki w paczce (3)
  • SKILL.lean.md 4 KB
  • SKILL.md 5 KB
  • agents/openai.yaml 1 KB

Wersje

W bazie nie ma innych skilli o nazwie fai-git-commit-best-practices.

Migawka bazy z 13.11.2026 · wersja paczki c5aa8fc79110 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100conventional-commit
    Tworzy komunikaty commitów w formacie Conventional Commits przy zatwierdzaniu zmian w kodzie i porządkowaniu historii gita.
  • 100conventional-commits
    Tworzy komunikaty commitów w formacie Conventional Commits przy zatwierdzaniu zmian w kodzie i porządkowaniu historii gita.
  • 100commitlint
    Sprawdza, czy komunikaty commitów mają format Conventional Commits, i wymusza go hookiem husky lub w CI, z własnymi regułami pod changelogi i semantic versioning.
  • 100git-commit
    Generuje komunikaty commitów w konwencji Conventional Commits dla projektów w Javie po zakończeniu zmian w kodzie.
  • 100git-conventional-commit
    Tworzy commity zgodne ze specyfikacją Conventional Commits v1.0.0, analizując zmiany przygotowane i nieprzygotowane oraz tworząc komunikaty z poprawnym typem, zakresem, opisem, treścią i stopką.
  • 100conventional-commits
    Prowadzi przez pisanie komunikatów commitów w stylu Conventional Commits oraz przegląd historii commitów.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.