搜索技能.../

Readme Maintenance | Skills Pool

技能档案

Readme Maintenance

Keep README.md and docs/ content aligned with current repository behavior, developer workflows, and deployment paths. Use when users ask to review, refresh, or correct project documentation, especially after command, tooling, endpoint, environment-variable, or architecture changes.

Birdiz0 星标2026年2月8日

职业
分类: 自动化工具

技能内容

README Maintenance Workflow

Inspect current sources of truth before editing README content:

Makefile
api/package.json
web/package.json
docker-compose.yml
API routes/controllers for documented endpoints

Detect and fix documentation drift:

Keep README.md concise and navigation-focused
Move feature-specific and API-specific details to docs/*.md
Add and maintain cross-links between docs files
Add missing setup and run paths (Docker and local)
Align command examples with current make targets
Align quality checks with current lint, typecheck, and test commands
Confirm endpoint paths and service URLs
Confirm environment variables and defaults

Preserve readability:

Keep README concise and task-oriented
Prefer short sections with copy-pasteable commands

相关技能

快速安装

Readme Maintenance

npx skills add Birdiz/Birdiz

下载 Skill 打开源码仓库

作者: Birdiz
星标: 0
更新时间: 2026年2月8日
职业

本页内容

01README Maintenance Workflow

Avoid repeating details that are already obvious from code

Validate after edits:

Re-read README.md and verify every command/path exists
Re-read docs/*.md and verify links and references are coherent
If README includes command workflows, run representative checks when practical
Summarize exactly what was changed and why

Output Expectations

Keep language concrete and current-state focused.
Include both local and Docker instructions when both are supported.
Document primary quality gates: lint, typecheck, and tests.
Prefer splitting dense documentation into linked files under docs/.

02

Output Expectations

软件开发人员

自动化工具

Init

Generate or update chat customization files for AI coding agents

microsoft184.0k

Openclaw Ghsa Maintainer

Maintainer workflow for OpenClaw GitHub Security Advisories (GHSA). Use when Codex needs to inspect, patch, validate, or publish a repo advisory, verify private-fork state, prepare advisory Markdown or JSON payloads safely, handle GHSA API-specific publish constraints, or confirm advisory publish success.

自动化工具

Coding Agent (bash-first)

Delegate coding tasks to Codex, Claude Code, or Pi agents via background process. Use when: (1) building/creating new features or apps, (2) reviewing PRs (spawn in temp dir), (3) refactoring large codebases, (4) iterative coding that needs file exploration. NOT for: simple one-liner fixes (just edit), reading code (use read tool), thread-bound ACP harness requests in chat (for example spawn/run Codex or Claude Code in a Discord thread; use sessions_spawn with runtime:"acp"), or any work in ~/clawd workspace (never spawn agents here). Claude Code: use --print --permission-mode bypassPermissions (no PTY). Codex/Pi/OpenCode: pty:true required.

Gh Issues

Fetch GitHub issues, spawn sub-agents to implement fixes and open PRs, then monitor and address PR review comments. Usage: /gh-issues [owner/repo] [--label bug] [--limit 5] [--milestone v1.0] [--assignee @me] [--fork user/repo] [--watch] [--interval 5] [--reviews-only] [--cron] [--dry-run] [--model glm-5] [--notify-channel -1002381931352]

Security Triage

Triage GitHub security advisories for OpenClaw with high-confidence close/keep decisions, exact tag and commit verification, trust-model checks, optional hardening notes, and a final reply ready to post and copy to clipboard.

Github

GitHub operations via `gh` CLI: issues, PRs, CI runs, code review, API queries. Use when: (1) checking PR status or CI, (2) creating/commenting on issues, (3) listing/filtering PRs or issues, (4) viewing run logs. NOT for: complex web UI interactions requiring manual browser flows (use browser tooling when available), bulk operations across many repos (script with gh api), or when gh auth is not configured.

软件开发人员