Skip to content

bestdeejay-design/agent-skills / skills/github-repo-hygiene

github-repo-hygiene

Verified

DEPRECATED meta-skill. Routes to the four focused repository skills that replaced it: repo-readme-assets (README + animated SVG header/footer), repo-community-files (LICENSE/CODE_OF_CONDUCT/CONTRIBUTING/SECURITY/SUPPORT/templates), repo-metadata-health (description/topics/GitHub Pages/community health/audit), repo-social-preview (og:image PNG). Load one of the four directly instead. Triggers: 'github hygiene', 'repo polish', 'github repo docs', 'оформить репозиторий', 'репозиторий готов к публикации'.

FileKindSize
README.mdmarkdown5.0 KB
SKILL.mdskill md2.9 KB
readme.ru.mdmarkdown1.1 KB
showcase.mdmarkdown4.7 KB
skill.jsonconfig1.2 KB
# github-repo-hygiene

> Проверка и обновление описательной части GitHub-репозитория + визуальное
> оформление README локальными анимированными SVG. Скилл для AI-агентов
> (opencode и аналогичные), поставляется с пакетом скриптов для CI-гейтов.

**Ключевое:** ноль внешних сервисов. Шапка и футер README — это
`assets/header.svg` / `assets/footer.svg` **в вашем репозитории**: анимация на
SMIL (`<animate>`), работает в `<img>` на GitHub без скриптов и внешних запросов.

## Возможности

- **Чек-лист Community Standards → 100%**: README (EN) + зеркало `README.<lang>.md`,
  распознаваемые LICENSE (`spdx_id`) и CODE_OF_CONDUCT (Contributor Covenant 2.1),
  CONTRIBUTING/SECURITY/SUPPORT, issue-формы YAML + PR-шаблон, CI,
  `community/profile` → `health_percentage`.
- **Метаданные**: description, topics (≤20, lowercase), homepage (Pages),
  social preview, релизы semver + `release.yml`, CHANGELOG.
- **Локальные анимированные SVG**: эффект «фон наплывает» (маска-вырез),
  морфинг волн (4 кадра, `Q`+`T`), рассинхрон 30%, блик-проход, twinkling.
  4 пресета: `default` / `minimal` / `dark-first` / `monochrome`.
- **Скрипты** (pure Python 3 stdlib, exit 0/1 — годятся для CI):
  - `scripts/generate_assets.py` — генерация header/footer (пресеты)
  - `scripts/extract_context.py` — авто-определение name/desc/стека/цветов
  - `scripts/validate_svg.py` — валидация SVG по правилам
  - `scripts/validate_repo.py` — 16-пунктовый чек-лист (gh API + filesystem)
  - `scripts/generate_social_preview.py` — генерация social preview PNG 1280×640 (требует Pillow)
- **CI-интеграция**: пример `examples/repo-hygiene.yml` — валидаторы как
  pre-merge check (read-only).

## Установка

Скопируйте директорию скилла в библиотеку скиллов агента
(например `~/.config/opencode/skills/github-repo-hygiene`).
Требования: `python3` (stdlib only). Для проверок метаданных — `gh` CLI
с авторизацией (`gh auth login`), это опционально.

## Быстрый старт

```bash
# 1. Авто-детект контекста репозитория (в корне клона)
python3 scripts/extract_context.py --gh-repo owner/repo

# 2. Генерация шапки/футера
python3 scripts/generate_assets.py \
  --name "Project Name" --desc "Short description" --user "owner" \
  --cold "#0ABAB5" --warm "#F64A8A" --preset default

# 3. Проверка SVG (для CI-гейта)
python3 scripts/validate_svg.py assets/

# 4. Полный чек-лист (локально или через API, --clone для remote)
python3 scripts/validate_repo.py owner/repo --clone
```

Вставьте в начало README.md:

```html
<p align="center">
  <a href="https://github.com/owner" target="_blank">
    <img src="assets/header.svg" alt="header" />
  </a>
</p>
```

(в конец — то же с `assets/footer.svg`; ссылки относительные — работают
в клонах и форках).

## Состав

| Файл | Назначение |
|---|---|
| `SKILL.md` | инструкция-воркфлоу для агента (точка входа) |
| `skill.json` | манифест (requirements, inputs/outputs) |
| `references/svg-animation.md` | полная спецификация SVG + шаблоны |
| `references/color-tokens.md` | decision tree: name/desc/цвета |
| `references/community-checklist.md` | 16 пунктов + команды проверки |
| `references/svg-presets.md` | пресеты оформления |
| `references/canonical-patterns.md` | каноны: GitHub Docs/API/github-docs/SPDX |
| `references/social-preview.md` | генерация social preview (og:image) |
| `scripts/` | 5 скриптов генерации/валидации |
| `examples/repo-hygiene.yml` | CI-воркфлоу-пример |
| `showcase.md` | «до/после» для каталогов |

## Эксплуатация

- После мажорных изменений (новые сервисы, смена стека, релиз) прогоняйте
  `validate_repo.py` — отчёт JSON, exit 0/1.
- Расхождение локализованных README ловится автоматически (сверка структуры
  заголовков).
- Web-интерфейс GitHub (бейджи, health %) обновляется 1–5 минут после пуша.

## Лицензия

MIT. Автор: [bestdeejay-design](https://github.com/bestdeejay-design).
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall