Gagnageymslan
Hvernig námsefnið er skipulagt á GitHub og hvernig þú lest það, leggur til breytingar og nýtir sniðmátin.
Námsefni þessa námskeiðs er opið og aðgengilegt á GitHub. Þú getur bæði lesið og lagt til breytingar — allt í gegnum venjulegt GitHub-vinnuflæði.
Uppbygging gagnageymslunnar
IDN302G/
├── docs/ ← Frumefni námskeiðsbókarinnar: Markdown, Quarto, myndir og stílar
│ ├── about-course/← Upplýsingar um námskeiðið, skipulag og námsmat
│ ├── ai-tools/ ← Efni um erindreka og ábyrga notkun gervigreindar
│ ├── github/ ← Efni um Git og GitHub
│ ├── reproducible-reports/ ← Endurtækar skýrslur
│ ├── regex/ ← Reglulegar segðir
│ ├── logic-sets/ ← Rökfræði, mengi og vensl
│ ├── sql-basics/ ← SQL grunnatriði
│ ├── sql-advanced/← SQL framhald
│ ├── storytelling/← Myndræn framsetning og gagnafrásögn
│ ├── styles/ ← Sérsniðnir stílar fyrir námskeiðsbókina
│ └── .quarto/ ← Staðbundið skyndiminni Quarto (ekki commit-að)
├── _site/ ← Afleidd vefsíða sem Quarto býr til (ekki commit-uð)
├── templates/ ← Sniðmát, m.a. TEAM.md fyrir hópa
├── data/ ← Gagnaskrár sem notaðar eru í æfingum
├── code/ ← Kóði og hjálparskrár sem styðja við sýnidæmi/æfingar
└── README.md ← Yfirlit yfir gagnageymsluna
docs/ er staðurinn þar sem efnið er skrifað og lagað. _site/ er renderuð útgáfa sem GitHub Pages birtir á vefnum (byggð af GitHub Actions). Ef þú sérð villu í námsefninu skaltu því leggja til breytingu í viðeigandi möppu undir docs/, ekki breyta _site/ beint.
Hvernig README virkar
README.md er forsíða gagnageymslunnar á GitHub. Þar eru leiðbeiningar um uppbyggingu, hvernig á að setja upp umhverfið og hvernig nemendur tengjast námskeiðinu. Lestu hana fyrst.
Breyta þessari síðu
Efst á hverri síðu í námskeiðsbókinni eru tveir hnappar:
Breyta þessari síðu — opnar skrána á GitHub þar sem þú getur lagt til leiðréttingu eða viðbót í gegnum Pull Request. Þetta er nákvæmlega sama ferli og þið notið í verkefnum ykkar — góð æfing.
Tilkynna villu eða athugasemd — opnar nýtt Issue á GitHub þar sem þú getur lýst villunni eða ábendinguna. Notaðu þetta ef þú ert ekki viss um hvernig á að laga hlutinn sjálfur.
Að leggja til breytingu á námsefninu með Pull Request er líka æfing í GitHub-vinnuflæði: þar sjást breytingin, umræðan og rýnin á sama hátt og í verkefnavinnu hópsins.
Ef þú kemst ekki í iRAT getur þú, í samráði við kennara, bætt það upp með því að leggja fram Pull Request sem gagnast námskeiðinu.
Breytingin á að tengjast þeirri lotu sem þú misstir úr. Hún þarf að vera raunverulegt framlag, til dæmis:
- bæta við ítarlegri útskýringu í viðeigandi kafla,
- laga villu eða óskýrt orðalag í námsefninu,
- bæta við litlu sýnidæmi, æfingu eða skýringarmynd,
- bæta README, leiðbeiningar eða sniðmát sem aðrir nemendur geta nýtt.
Uppbót er gerð með því að opna Pull Request á þessa gagnageymslu, í samráði við kennara.
Sniðmát / Templates
Helstu grunnsniðmátin eru í templates/ möppunni í rót gagnageymslunnar. Afritið þau yfir í eigin gagnageymslu og fyllið út eftir því sem við á.
| Skrá | Hvenær | Lýsing |
|---|---|---|
TEAM.md |
Vika 1 |
Hópsamningur — tungumál, vinnureglur, verkefnastjóraröð |
README.md |
Vika 1 | Forsíða gagnageymslunnar — verkefnislýsing, hópurinn, uppbygging |
AGENTS.md |
Vika 2 | Leiðbeiningar fyrir gervigreindarerindrekа — hvað má og má ekki |
CONTRIBUTING.md |
Vika 2 | Vinnuferli — útibúaheiti, commit-skilaboð, PR-ferli, kóðarýni |
PULL_REQUEST_TEMPLATE.md |
Vika 2 | Sniðmát fyrir PR-lýsingar — gátlisti og leiðbeiningar |
iREF.md |
Eftir hverja einingu | Einstaklingsbundin endurspeglunargreining |
Listinn er ekki tæmandi. Fleiri sniðmát og dæmi verða kynnt í samhengi við einstakar lotur og verkefni.