Struktura datotek

Hiararhija datotek 📁

Datotecna hiararhija, ali struktura, je definicija imenovanja map ter datotek v tem projektu.

Strogo uveljavljeno preverjanje je potrebno, da ostane projekt urejen ter uporaben tudi po daljsem casu uporabe ter veliko kolicino dodanega materiala. Za olajsanje postopka prispevanja je v prijektu implementirano avtomaticno preverjanje hiararhije.

{ program }/
    { predmet }/
        { solsko leto }-info/
            { any }
        { solsko leto }-izpiti/
            { koledarsko leto }-{ mesec }-{ dan }/
                { any }
        { solsko leto }-kolokviji/
            { koledarsko leto }-{ mesec }-{ dan }/
                { any }
        { solsko leto }-material/
            { any }
        { solsko leto }-naloge/
            { indeks }-{ ime snovi ali kategorije }/
                material/
                    { any }
                README.md
                { naziv }/
                    { any }
        { solsko leto }-zapiski/
            { indeks }-{ ime snovi ali kategorije }/
                { any }
        material/
            { any }
        README.md

Kaj vsebuje katera podmapa

• info - informacije o razlicnih dogodkih, kontaktne podatke do profesorjev/laborantov, dostopi do ucilnic, skupine za komunikacije (npr. discord za OVS)
• izpiti - izpite ter njihove resitve in obrazlage
• kolokviji - kolokvije ter njihove resitve in obrazlage
• material - material, lahko podan s strani izobrazevalnega sistema (prof, eucilnice, asistenti) ali z drugih virov
• naloge - naloge ter resitve nalog
  • vsaka naloga ima README.md datoteko, ki vsebuje navodila ter material naloge
  • vsaka naloga ima lahko tudi material podmapo, ki vsebuje podan material v navodilih naloge.
• zapiski - zapiski iz predavanj, vaj ter domacih ponavljanj

Več info o datotecni strukturi

• spremenljivke

  • any - kakrsno koli zaporedje znakov v skupini a-zA-Z0-9, - in _.

  • indeks - vsiljeno zaporedje datotek ter preventiva podvajanja v primeru istega naslova

    • vrednosti od ena (1) naprej
    • vrednosti z eno števko imajo 0 kot prvi znak
    • npr. 03, 09, 14, 35

  • program - kratica programa

    • npr. vss-1, vss-2

  • predmet - kratica predmeta

    • v velikih črkah
    • npr. RA, P1

  • solsko leto - kratica solskega leta

    • koledarsko leto v katerem se je solsko leto zacelo, ter zadnji dve stevki naslednjega koledarskega leta
    • npr. 2021-22, 2020-21

  • koledarsko leto - no explanation needed

    • npr. 2021, 2022

  • mesec - zaporedna stevilka meseca v letu

    • vrednosti z eno števko imajo 0 kot prvi znak
    • npr. 03, 09, 10, 12

  • dan - zaporedna stevilka dneva v mesecu

    • vrednosti z eno števko imajo 0 kot prvi znak
    • npr. 03, 09, 14, 22

  • ime snovi ali kategorije - ime poglavja in/ali snovi

    • vse v malih črkah
    • npr. seznami-terke-zanka-for, 6-dec-12-dec, pisanje-funkcij, 25-oct-31-oct-nacini-naslavljanja

  • naziv - lastni naziv

    • unikaten lastni naziv, lahko je ime-priimek, lahko jn6942, ali v primeru da zelis ostati anonimen/-a uporabi svoje uporabnisko ime platforme GitPlac.
    • uporabljeno za diferenciranje razlicnih resitev za isto nalogo
    • npr. aljaz-starc, jn6942, aljaxus, janez-novak, tinkopalinko123

• ( ... )? - vsebina v oklepajih je neobvezna

  • npr. za prva-(druga-)?tretja bi veljala oba slednja primera:
    • prva-tretja
    • prva-druga-tretja

Avtomaticna validacija

CI pipeline vsebuje job validate-files, ki pregleda ter validira, da vse datoteke sledijo hiararhiji definirani v datoteki .directoryvalidator.json.

V primeru, da struktura ni veljavna, bo job za validacijo spodletel, posredno tudi celoten pipeline, sicer pa ce je job uspesno stekel se pipeline nadaljuje.

---

Zadnja posodobitev: December 9, 2022