Amanoba Logo
Back to Course

Repo setup na Git hygiene

Day 8 of 30 · AI Jeneretivu 2026: Jenga App na Agent za AI

One-liner: Unda repo safi ya GitHub na workflow rahisi.
Time: 20 hadi 30 dakika
Deliverable: Repo yenye README na sheria za msingi

Learning goal

You will be able to: Kusanidi repo ya GitHub yenye workflow safi kwa app ndogo ya AI.

Success criteria (observable)

  • Repo ina README wazi na license.
  • Sheria za branching zimeandikwa.
  • Issues zimeundwa kwa kazi muhimu.

Output you will produce

  • Deliverable: Repo yenye README na sheria za msingi
  • Format: GitHub repository
  • Where saved: Akaunti ya GitHub na noti za kozi

Who

Primary persona: Digital nomad anayesimamia repo ya solo Secondary persona(s): Washirika wa ujenzi Stakeholders (optional): Wateja wa awali

What

What it is

Repo safi ya GitHub yenye README, license, issues, na sheria rahisi za branching. Inapanga kazi na huifanya iwe rahisi kushirikiana.

What it is not

Si workflow ya enterprise iliyo ngumu. Si mfumo wa CI mkubwa.

2-minute theory

  • Repo safi hupunguza msuguano.
  • Issues husaidia kufuatilia kazi.
  • README nzuri huongeza uaminifu.

Key terms

  • Repository: Nyumbani kwa code na docs.
  • Branching rule: Sera rahisi ya mabadiliko na merges.

Where

Applies in

  • GitHub
  • Local development

Does not apply in

  • Pipelines ngumu za deployment

Touchpoints

  • README
  • Issues
  • Branch settings

When

Use it when

  • Unaanza ujenzi
  • Unataka kushirikiana

Frequency

Mara moja kwa repo

Late signals

  • Historia ya commits isiyo safi
  • Kazi isiyo na mwenye

Why it matters

Practical benefits

  • Ushirikiano wa haraka
  • Dokumenti wazi
  • Migongano michache ya merge

Risks of ignoring

  • Kazi kupotea
  • Onboarding kuwa ngumu

Expectations

  • Improves: uwazi na teamwork
  • Does not guarantee: bugs chache

How

Step-by-step method

  1. Unda repo na ongeza README.
  2. Ongeza license na issue templates.
  3. Andika sheria ya branching.
  4. Unda issues 5 za MVP.

Do and don't

Do

  • Weka README fupi na muhimu
  • Tumia issues kufuatilia kazi

Don't

  • Commit secrets
  • Kufanya kazi kwenye main bila mpango

Common mistakes and fixes

  • Mistake: Hakuna README. Fix: Andika sehemu ya setup na purpose.
  • Mistake: Hakuna issues. Fix: Ongeza tasks kama issues.

Done when

  • README inaeleza app inafanya nini.
  • Sheria ya branching imeandikwa.
  • Angalau issues 5 zipo.

Guided exercise (10 to 15 min)

Inputs

  • Orodha ya MVP
  • Akaunti ya GitHub

Steps

  1. Unda repo na README.
  2. Ongeza license na issue template.
  3. Unda issues 5 za MVP.

Output format

Field Value
Repo URL
Muhtasari wa README
Branch rule
Orodha ya issues

Pro tip: Tumia issue moja kwa kila kipengele muhimu.

Independent exercise (5 to 10 min)

Task

Sasisha README ili itaje mtumiaji na matokeo.

Output

README iliyoboreshwa.

Self-check (yes/no)

  • Je, README inataja mtumiaji na matokeo?
  • Je, issues ni wazi na zenye wigo?
  • Je, secrets zimezuiwa?
  • Je, sheria ya branch imeandikwa?

Baseline metric (recommended)

  • Score: Vigezo 3 kati ya 4 vimetimia
  • Date: 2026-02-07
  • 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: Miongozo ya README bora. Read: https://www.makeareadme.com/