1. tēma: Ievads un darba vide. 5. stunda: Kodu koplietošana un dokumentēšana.

Tavs šīs stundas izaicinājums: Tu iemācīsies atpazīt dokumentācijas nozīmi programmēšanā, patstāvīgi izveidot skaidru projekta aprakstu un ievērot sadarbības etiķeti, publicējot savu darbu GitHub vietnē.

SR 2.4.9. (Kodu koplietošana), 3.1.5. (Intelektuālais īpašums un autorība)

Teorija: Kāpēc dokumentēt kodu?

1. uzdevums: Projekta vizītkartes izveide

Izveidot galveno informācijas failu, lai ikviens uzreiz saprastu Tava projekta mērķi.

Izpildes soļi:

  1. VS Code atver savu mapi mana_spele.
  2. Izveido jaunu failu: README.txt.
  3. Pirmajā rindā ieraksti spēles nosaukumu (piem., "MEŽA PIEDZĪVOJUMS").
  4. Zem nosaukuma pieraksti: "Šī ir mana pirmā Python spēle, kas tapusi programmēšanas kursa ietvaros."
  5. Saglabā failu (Ctrl+S).

2. uzdevums: Instrukciju un autorības pievienošana

Sagatavot projekta aprakstu tā, lai lietotāji zinātu, kā spēli palaist un kurš to radījis.

Izpildes soļi:

  1. Papildini README.txt ar sadaļu KĀ SPĒLĒT.
  2. Uzskaiti prasības: Python 3.12 instalācija un komanda palaišanai: python tests.py.
  3. Faila beigās pievieno sadaļu AUTORS un norādi savu vārdu, uzvārdu un gadu.
  4. Pārliecinies, ka teksts ir pārskatāms un bez gramatikas kļūdām.

3. uzdevums: Dokumentācijas publicēšana GitHub

Nostiprināt darba ciklu, sinhronizējot dokumentāciju ar attālināto krātuvi.

Izpildes soļi:

  1. Terminālī pārbaudi izmaiņas: git status.
  2. Pievieno dokumentu: git add README.txt.
  3. Izveido vēstures punktu: git commit -m "Pievienota projekta dokumentācija un autora dati".
  4. Nosūti uz mākoni: git push.
  5. Atver pārlūkā savu GitHub krātuvi un pārliecinies, ka fails ir tur un ir salasāms.

Biežākās kļūdas (un kā tās labot):

Zini, kāpēc tas ir svarīgi? Labs programmētājs neraksta kodu tikai datoram; viņš raksta kodu un dokumentāciju citiem cilvēkiem. Prasme izskaidrot savu darbu ir tikpat svarīga kā prasme programmēt.

Profesionāls darba cikls terminālī

git status                         # Pārbaudām, kas mainīts
git add README.txt                 # Sagatavojam konkrēto failu
git commit -m "Pievienots README"  # Fiksējam vēsturē
git push                           # Nosūtām uz GitHub
[main 7d2e1a9] Pievienota dokumentācija
1 file changed, 12 insertions(+)
To github.com:skolens/mana_spele.git
⬅ Iepriekšējā stunda Nākamā stunda ➡