1.5 Dokumentēšana, README un Licences

1. uzdevums - Iesildies ar gatavu piemēru

Šis ir īss iesildīšanās uzdevums. Nokopē sagatavi, ielīmē to pareizajā koda vietā un palaid. Šeit pietiek droši izmēģināt tēmu 1.5 Dokumentēšana, README un Licences; detalizētu izpratni veidosi nākamajos uzdevumos.

Kopējamais piemērs vai sagatave: izmanto šo bloku kā starta punktu, nevis kā gala risinājumu.

mkdir iesildisanas-projekts
cd iesildisanas-projekts
code main.py

temats = "1.5 Dokumentēšana, README un Licences"

print("Iesildīšanās sākta")
print("Tēma:", temats)
print("Kods darbojas")

1. Atver darba failu vai rīku. Komandas izpildi terminālī, bet Python piemēru ievieto main.py failā.
2. Nokopē visu piemēra bloku no šī uzdevuma un ielīmē to norādītajā vietā.
3. Palaid kodu tieši tādu, kāds tas ir, un pārliecinies, ka parādās rezultāts, izvade vai vismaz nav kļūdas paziņojuma.
4. Atrodi vienu drošu vietu, ko drīkst mainīt: tekstu, skaitli, krāsu, mainīgā vērtību vai testa ierakstu.
5. Maini tikai šo vienu vērtību un palaid kodu vēlreiz.
6. Salīdzini rezultātu pirms un pēc izmaiņas. Ja parādās kļūda, atcel pēdējo izmaiņu un palaid vēlreiz.
7. Turpini pie 2. uzdevuma tikai tad, kad šis mazais piemērs darbojas.

2. uzdevums - Ievieto algoritmu projektā

Pievieno šīs stundas paņēmienu kā nelielu, pārbaudāmu projekta daļu.

1. Izvēlies vienu konkrētu projekta vietu: failu struktūru, Git darbību, README ierakstu, palaižamu Python failu vai pārbaudes komandu.
2. Nosauc failus, mainīgos un commit ziņas skaidri pēc to lomas.
3. Uzraksti kodu vai komandu secību, kas veic vienu skaidru darbību un dod pārbaudāmu rezultātu.
4. Savieno šo darbu ar esošo projekta mapi, nevis atstāj to atsevišķā demonstrācijā.
5. Pievieno vienu īsu komentāru vai README rindu tikai tur, kur tas palīdz saprast darbību.
6. Pārbaudi, ka fails palaižas vai Git stāvoklis ir saprotams.
7. Salabo pirmo atrasto kļūdu pirms paplašini risinājumu.
8. Veic Git commit ar īsu ziņu par izveidoto projekta daļu.

3. uzdevums - Testē darbu un izdari secinājumu

Pārbaudi, vai projekta fragments ir atkārtojams un saprotams.

1. Izveido trīs pārbaudes scenārijus: parasta palaišana, tukša/nepareiza vērtība un atkārtota palaišana pēc izmaiņām.
2. Palaid parasto scenāriju un pārbaudi termināļa, faila vai Git izvadi.
3. Palaid kļūdaino scenāriju un pārbaudi, vai problēma ir saprotama.
4. Palaid atkārtotu scenāriju pēc vienas mazas izmaiņas.
5. Izlabo vienu konkrētu problēmu kodā, failu struktūrā vai komandu secībā.
6. Pārbaudi labojumu vēlreiz.
7. Beigās pieraksti vienu secinājumu: kura koda rinda, komanda vai projekta struktūras solis vislabāk palīdzēja saprast tēmu 1.5 Dokumentēšana, README un Licences.

Papildu uzdevums - Pievieno mazu projekta uzlabojumu

Ja pamatdarbs ir pabeigts, paplašini projektu ar vienu nelielu, pārbaudāmu uzlabojumu.

1. Izvēlies vienu papildinājumu: jaunu pārbaudes komandu, README sadaļu, palaišanas piemēru vai mazu Python funkciju.
2. Pievieno to esošajā projekta struktūrā.
3. Pārbaudi, ka pamatdarbs un papildinājums darbojas kopā.
4. Saglabā izmaiņas ar Git commit tikai pēc veiksmīgas pārbaudes.

• Licence nesaglabājas: Ja GitHub mājaslapā failu nenosauksi precīzi par LICENSE (ar lielajiem burtiem), sistēma nepiedāvās "Choose a license template" pogu.
• Konflikti (Merge Conflicts): Ja izmainīsi README.md GitHub mājaslapā un vienlaicīgi izmainīsi to pašu failu savā datorā (VS Code), mēģinot sinhronizēt radīsies konflikts. Risinājums: Vienmēr taisi Fetch origin pirms sāc strādāt!
• Markdown virsraksti nestrādā: Starp tēmturi # un pašu tekstu OBLIGĀTI jāatstāj atstarpe. (#Virsraksts = parasts teksts, # Virsraksts = liels virsraksts).