跳到正文
cccskills
免费在 GitHub 公开

codexkit-repo-onboarding

Rapidly map a new codebase, identify the runtime model, risk zones, and first high-value next steps.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(5)

  • SKILL.md2.3 KB
  • agents/openai.yaml194 B
  • examples/common-mistakes.md778 B
  • examples/good-output.md909 B
  • verification/checklist.md1.3 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Repo Onboarding

Use this skill when entering an unfamiliar repository and you need a dependable first-pass map before making changes.

Objectives

  • identify the main runtime and package manager
  • locate the actual app entrypoints instead of guessing
  • surface tests, linting, build, and deployment hooks
  • call out fragile areas, generated code, and secret-handling risk

Workflow

  1. Read the top-level manifest, README, and directory structure.
  2. Find the real execution path from entrypoint to key modules.
  3. Identify quality gates: lint, type-check, tests, e2e, build.
  4. Summarize the codebase in a compact architecture note.
  5. Propose the safest next step for the current task.

Deliverable

Produce a short onboarding brief with:

  • stack summary
  • critical directories
  • commands worth running
  • likely risk zones
  • open questions that truly block execution

Avoid

  • rewriting architecture docs before the repo is understood
  • assuming the largest folder is the main app
  • recommending broad refactors during onboarding

Quality Criteria

  • Steps are executable in sequence without external context
  • Decision points have clear if/then branching
  • Rollback or abort procedures are documented for risky steps
  • Expected duration or time-per-step is estimated

Verification (4C)

CheckQuestion
CorrectnessDo the steps execute correctly in the order specified?
CompletenessAre decision points, error handling, and escalation paths all documented?
Context-fitCould someone with the right access but no prior context complete this runbook?
ConsequenceIf Step N fails and the operator skips to Step N+1, what breaks?

Edge Cases

  • Steps require access the operator doesn't have — Document exact access requirements upfront. Include escalation contact for emergency access.
  • Environment differs from documented state — Add a pre-flight check as Step 0 to verify prerequisites before starting.
  • Runbook is triggered during off-hours — Document who to contact and which steps can be safely deferred to business hours.

Changelog

  • v1.0.0 — Initial release

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Design rigorous A/B test plans with hypothesis, sample size calculation, Minimum Detectable Effect (MDE), randomization strategy, and decision rules. Includes guardrail metrics and rollout playbook. Use when planning product experiments, conversion optimization, or data-driven feature decisions.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Review REST and GraphQL API designs for consistency, usability, and best practices. Covers naming conventions, versioning strategy, error format, pagination, authentication patterns, and breaking change detection. Use when reviewing API specs, designing new APIs, or auditing existing endpoints.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Write Architecture Decision Records (ADRs) following the Michael Nygard format. Captures context, options considered, decision rationale, and consequences. Use when making technology choices, framework selections, or any architectural decision that future developers need to understand.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Assess organizational readiness for financial audits (internal or external). Map assertions to account balances, check evidence completeness, score readiness using a Red/Amber/Green framework, and generate a remediation timeline. Aligned with SOX, IFRS, and GAAP audit standards. Use before scheduled audits or when preparing for first-time compliance.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Design safe recurring Codex automations with clear prompts, outputs, schedules, and gating rules.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Refine Product Backlog Items to meet INVEST criteria. Write User Stories with Acceptance Criteria in Given/When/Then format, estimate with Story Points, and flag dependencies. Use before sprint planning when backlog items need grooming. Do not use to prioritize the backlog — that is the Product Owner's decision.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

查看 hoavdc 的全部技能

报告此技能的问题