repo-orientation

Create a repo orientation playbook documenting conventions, commands, and guardrails.

Updated Feb 18, 2026
One-click install
npx skills add https://github.com/askaret/codex-skills --skill repo-orientation-askaret
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-orientation
Source: https://github.com/askaret/codex-skills/tree/main/.agents/skills/repo-orientation
Command: npx skills add https://github.com/askaret/codex-skills --skill repo-orientation-askaret

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Use when starting work in a new repo (or after a big refactor) to map conventions, commands, and guardrails. Do NOT implement features; only produce a repo playbook.

Core Features & Use Cases

  • Create a concise, project-specific playbook that other skills can follow reliably.
  • Document build, test, lint/format, local run commands, and architecture boundaries to reduce onboarding time.
  • Define CI workflows, required checks, and guardrails to ensure consistent governance across teams.

Quick Start

Create a short repo playbook following the checklist above and share it in your project root under REPO_PLAYBOOK.md.

Frequently Asked Questions about repo-orientation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document build commands and CI workflows when onboarding to a new repo?

Create a repo orientation playbook that captures build commands, CI workflows, and required checks to reduce onboarding time. It documents conventions, run/debug steps, and architecture boundaries into a concise project-specific guide shared as REPO_PLAYBOOK.md.

What is a repo playbook and when do I need one?

A repo playbook is a concise document capturing conventions, commands, and guardrails for a new or refactored project. You need one when starting work in a new repo or after a major refactor to map architecture boundaries and ensure consistent governance across teams.

How do I establish guardrails and security tooling checks for a refactored project?

Define guardrails and security tooling checks by documenting required CI workflows and conventions in a repo playbook. The playbook captures build, test, lint, and run/debug checks to ensure consistent governance across backend and frontend projects during refactoring.

Can I use a repo orientation playbook for both backend and frontend projects?

Yes, a repo orientation playbook is applicable across both backend and frontend projects. It provides coverage for key projects, API contracts, migrations, CI workflows, and architecture boundaries, ensuring conventions and guardrails are consistently documented regardless of stack.

Does a repo orientation playbook implement features or write code for the project?

No, a repo orientation playbook does not implement features or write code. It only produces a concise playbook that maps conventions, commands, and guardrails, designed to be followed reliably by other skills working on the project.

What's the best way to capture API contracts and migration steps for a new repository?

The best way to capture API contracts and migration steps is generating a repo orientation playbook. It provides coverage for key projects, API contracts, migrations, and CI workflows, documenting architecture boundaries and conventions in a single REPO_PLAYBOOK.md file.