Amanoba Logo
Back to Course

Repo setup and Git hygiene

Day 8 of 30 · Generative AI 2026: Build AI Apps and Agents

One-liner: Create a clean GitHub repo and workflow.
Time: 20 to 30 min
Deliverable: Repo with README and basic workflow rules

Learning goal

You will be able to: Set up a GitHub repo with a clean workflow for a small AI app.

Success criteria (observable)

  • The repo has a clear README and license.
  • Branching rules are defined.
  • Issues are created for key tasks.

Output you will produce

  • Deliverable: Repo with README and basic workflow rules
  • Format: GitHub repository
  • Where saved: GitHub account and course folder notes

Who

Primary persona: Digital nomad managing a solo repo Secondary persona(s): Collaborators Stakeholders (optional): Early buyers

What

What it is

A clean GitHub repo with a README, license, issues, and basic branching rules. It keeps work organized and easy to share.

What it is not

It is not a complex enterprise workflow.

2-minute theory

  • Clean repos reduce friction for you and future collaborators.
  • Issues create visibility for what is next.
  • A good README improves onboarding and trust.

Key terms

  • Repository: The project home for code and docs.
  • Branching rule: A simple policy for changes and merges.

Where

Applies in

  • GitHub
  • Local development

Does not apply in

  • Deployment pipelines beyond basic CI

Touchpoints

  • README
  • Issues
  • Branch settings

When

Use it when

  • Starting the build
  • Preparing for collaboration

Frequency

Once per repo

Late signals

  • Unclear work ownership
  • Messy commit history

Why it matters

Practical benefits

  • Faster collaboration
  • Clearer documentation
  • Fewer merge conflicts

Risks of ignoring

  • Confusion and lost work
  • Hard to onboard help

Expectations

  • Improves: clarity and teamwork
  • Does not guarantee: fewer bugs

How

Step-by-step method

  1. Create the repo and add a README.
  2. Add a license and basic issue templates.
  3. Define a simple branching rule.
  4. Create issues for MVP tasks.

Do and don't

Do

  • Keep the README short and useful
  • Use issues for tasks, not just ideas

Don't

  • Commit secrets
  • Work on main without a plan

Common mistakes and fixes

  • Mistake: No README. Fix: Write a short setup and purpose section.
  • Mistake: No issues. Fix: Add tasks as issues with scope.

Done when

  • README explains what the app does.
  • Branching rule is written.
  • At least 5 issues exist.

Guided exercise (10 to 15 min)

Inputs

  • MVP scope list
  • GitHub account

Steps

  1. Create the repo and add a README.
  2. Add a license and issue template.
  3. Create five issues for MVP tasks.

Output format

Field Value
Repo URL
README summary
Branch rule
Issue list

Pro tip: Use one issue per feature, not per tiny task.

Independent exercise (5 to 10 min)

Task

Rewrite the README to include the user and outcome.

Output

Updated README text.

Self-check (yes/no)

  • Does the README name the user and outcome?
  • Are issues clear and scoped?
  • Are secrets excluded?
  • Is a branch rule written?

Baseline metric (recommended)

  • Score: 3 of 4 checks met
  • Date: 2026-02-06
  • Tool used: GitHub

Bibliography (sources used)

  1. GitHub Docs. GitHub. 2024-01-01. Read: https://docs.github.com/

  2. Keep a Changelog. 2024-01-01. Read: https://keepachangelog.com/

Read more (optional)

  1. How to Write a README Why: Best practices for onboarding. Read: https://www.makeareadme.com/