# AI GitHub Repo Onboarding: Read Before Recommending

An unfamiliar repository is easier to understand when the explanation points to actual files and commands. Select an authorized repository and branch, then ask the coding assistant to map entry points and development instructions. Confirm available access and tools; never infer that connection means every repository is readable.

## Your brief

1. Identify the exact repository, branch and task. Confirm the account or integration is authorized for that repository and review the project’s current instructions before edits.

   ____________________

2. Provide or request the README, package manifests, entry points and relevant configuration. Keep secrets out of prompts and distinguish files actually read from links merely mentioned.

   ____________________

3. Define a read-only first pass, the intended runtime and a small contribution goal. Ask for setup commands to be explained before any environment-changing action.

   ____________________

## Prompt

Inspect this authorized repository [repo and branch] using the files available to you. List files actually read, architecture entry points, setup instructions, test commands and unknowns. Follow repository instructions. Do not claim code execution or private-file access without evidence. Propose one small first task with verification steps. Stop for missing access rather than inventing file contents.

## Illustrative example

Illustrative repository has a React frontend and a separate API package. The onboarding map cites the actual manifest for each, identifies the API base configuration and notes that local credentials are unavailable. It proposes a small input-validation improvement. It does not claim the app runs until the appropriate commands have actually completed.

## Acceptance checks

- [ ] Are repository, branch and the list of files actually read explicit?
- [ ] Do architecture and command recommendations point to current project files rather than guessed conventions?
- [ ] Are read-only findings, proposed edits and executed tests clearly distinguished?

Do not paste private tokens to overcome missing repository access. Use the supported authorization flow and least-needed repository permissions. A code suggestion based on a public URL is not a review of inaccessible private source.

---

Brainbaby · https://brainbaby.ai/blog/ai-github-repository-onboarding

CC BY 4.0 — https://creativecommons.org/licenses/by/4.0/