Skip to content
Back to skills

003 Name Skill 3d375dc8

ASecurity

Review project consistency after code changes. Checks if code, design docs, CHANGELOG, and README are aligned. Use after finishing code modifications and before committing.

  • 9 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added October 11, 2026
documentationgobashrefactoringgitapidocumentation

Works with

  • cli
  • api

Security analysis

A100/100

Scanned October 11, 2026

npx -y skills add tools-only/X-Skills --skill 003-name-skill_3d375dc8 --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of 003 Name Skill 3d375dc8?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for 003 Name Skill 3d375dc8
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/tools-only-003-name-skill-3d375dc8/badge)](https://www.skillsdirectory.com/skills/tools-only-003-name-skill-3d375dc8)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

SKILL.md
---
name: git-check
description: Review project consistency after code changes. Checks if code, design docs, CHANGELOG, and README are aligned. Use after finishing code modifications and before committing.
---

# Git Check - Project Consistency Review

## Overview

This skill reviews project consistency after code changes to ensure:
- Code matches design documents
- CHANGELOG is updated for new features/fixes
- README reflects current functionality
- No outdated documentation

## When to Use

Trigger `/git-check` after:
- Completing a feature implementation
- Fixing a bug
- Before creating a PR
- After significant code refactoring

## Review Checklist

### 1. Code vs Design Docs

Check if implementation matches design:
- Architecture follows design patterns
- API endpoints match specification
- Data models align with schema

```bash
# Find design docs
find . -name "DESIGN.md" -o -name "*.design.md" -o -name "design*.md"
```

### 2. CHANGELOG Update

Verify CHANGELOG.md includes:
- New features added
- Bugs fixed
- Breaking changes noted
- Version number updated (if applicable)

```bash
# Check recent changes vs CHANGELOG
git diff HEAD~5 --name-only
cat CHANGELOG.md | head -50
```

### 3. README Accuracy

Ensure README.md reflects:
- Current installation steps
- Updated usage examples
- New CLI commands/options
- Correct configuration

```bash
# Compare README with actual code
cat README.md
```

### 4. Consistency Report

Generate a report:

```markdown
## Consistency Check Report

### Files Changed
- [ ] List modified files

### Documentation Status
- [ ] CHANGELOG updated: Yes/No
- [ ] README accurate: Yes/No
- [ ] Design docs aligned: Yes/No

### Issues Found
- Issue 1: ...
- Issue 2: ...

### Recommendations
- Action 1: ...
- Action 2: ...
```

## Workflow

```
Code Changes Complete
        ↓
    /git-check
        ↓
┌───────────────────────┐
│ 1. Read changed files │
│ 2. Check CHANGELOG    │
│ 3. Verify README      │
│ 4. Compare with docs  │
│ 5. Generate report    │
└───────────────────────┘
        ↓
    Fix Issues (if any)
        ↓
    git commit
```

## Usage

```
/git-check              # Full consistency review
/git-check --quick      # Quick check (CHANGELOG + README only)
/git-check --verbose    # Detailed report with suggestions
```

## Example Output

```
## Git Check Report

### Changed Files (last commit)
- src/storage.py
- src/main.py

### CHANGELOG Status
⚠️  CHANGELOG.md not updated for recent changes

### README Status
✅ README.md is up to date

### Recommendations
1. Add entry to CHANGELOG.md:
   - "fix: save url/source/category in sent_news.json"
```

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…