Stanje pravil o prispevkih
Stanje
Odprto. Ta stran navaja, katera pravila za prispevke v tej zbirki dokazano veljajo in katerih ni. Nadomeščena bo, ko bodo odprta vprašanja odločena.
Izhodišče
Področje Projekti vodi sodelujoče do oddaje spremembe. Od tam naprej veljajo pravila, ki si jih postavi projekt: na katero vejo sodi sprememba, kdo jo pregleda in kdaj se sprejme. Del teh pravil je v tej zbirki zapisan in dokazano velja, drugi del ne. Brez tega razlikovanja nastane najdražja vrsta dokumentacije: takšna, ki navaja pravilo, ki se ga nihče ni zavezal upoštevati. Takega pravila nihče ne upošteva, pa tudi ovrže ga nihče.
Kaj dokazano velja
| Področje | Pravilo | Kje je to razvidno |
|---|---|---|
| Slog kode | PSR-12, brez izjem od pravil | konfiguracija preverjanja v delovnem prostoru ter ukaza composer cs in composer cbf |
| Statična analiza | predvidena, stopnja 4 | konfiguracija analize in ukaz composer stan |
| Sporočilo commita | vsak commit navede svoj delovni element v posebni zadnji vrstici | projektna pravila zbirke; brez te vrstice delovni element in koda nista povezana |
| Soavtorstvo | noben model ni naveden kot soavtor commita | projektna pravila zbirke |
| Prevzemni preizkus vsake spremembe | preverjanje skladnje, poskusni zagon, besedila vmesnika v petih jezikih, ponovna gradnja svežnja CSS, primerjava dnevnika napak | projektna pravila zbirke |
| Jezik | komentarji v izvorni kodi in dokumenti v repozitoriju v angleščini, dokumentacija v wikiju v nemščini, vmesniki v petih jezikih | projektna pravila zbirke |
| Navedba avtorja | stalen podatek o avtorju in naslovu za lastno kodo | projektna pravila zbirke |
| Signal izdaje | datum v manifestu paketa je signal, po katerem se prepozna posodobitev | projektna pravila zbirke |
| Kdo odloča o sodelovanju | vzdrževalci posameznega projekta, brez skrbniških pravic wikija | zaslon Mitglieder (Člani) vsakega projekta; preverjanje je v Domain/ProjectMembership in ga pokrivajo lastni testi |
| Meja te pristojnosti | vzdrževalec dodeljuje vlogi bralca in sodelavca, vloge vzdrževalca pa ne | isto preverjanje; zavrne tudi ročno sestavljeno oddajo obrazca |
| Zagon testov | vsak paket s testno mapo ima lastno konfiguracijo testov in se zažene iz svoje korenske mape | konfiguracijske datoteke same, vse z enakimi stikali za strogost; noben paket s testno mapo ni brez nje |
| Statična analiza v praksi | vsi paketi zbirke, stopnja 4, obstoječe stanje zamrznjeno | seznam poti v konfiguraciji analize; zagon se konča brez najdb samo, če ni prišlo nič novega. Seznam navaja vsak paket posebej – nov paket ni zajet samodejno, zato ga tja vpiše tisti, ki ga ustvari |
| Ime veje pri vračanju sprememb | na stopnji predlagati končna točka Git sprejme samo reference pod refs/heads/users/<uporabniško ime>/ in vse drugo zavrne, preden doseže izvorni sistem; na stopnji pisati ta omejitev ne velja | preverjanje je v Domain/ReceivePackGuard in ga pokrivajo lastni testi. Nobena od štirih predlog za priklop ne dodeli stopnje predlagati; ta nastane samo iz posebej napisanega pravila |
Česa ni
| Področje | Ugotovitev |
|---|---|
| Model vej | Ni pravila. Ni določeno, na katero vejo sodi sprememba, kako naj se veja imenuje in kdaj se odstrani. Tehnična omejitev stopnje predlagati iz prve tabele ni takšno pravilo: omejuje, kaj končna točka sprejme, ne pove pa ničesar o tem, kam sprememba vsebinsko sodi. |
| Postopek pregleda | Ni pravila. Določena nista ne pristojnost ne merilo, kdaj je pregled uspešen. |
| Pravila združevanja | Ni pravila. |
| Označevanje različic | Ni sheme. Od uvedbe Sestavljalnik paketov (v nemščini) obstajata DVA signala izdaje: datum v manifestu plugin.info.txt in zapisano stanje v release.stable datoteke wkcomponent.json. Drugi je natančen, nespremenljiv in sledljiv, vendar trenutno kaže na commit, ne na poimenovano različico, ker noben repozitorij nima oznake. Kanal Stabilno zato dostavlja »kar je nekega dne prestalo preverjanja in je bilo uvedeno«, ne pa »kar je bilo izdano«. Zaporedja različic ne izraža ne prvi ne drugi signal. |
| Seznam sprememb | Ni dogovora. Seznam sprememb ima le eden od lastnih paketov. |
| Prijava varnostnih ranljivosti | Za lastne pakete je ni. |
| Imenovanje vzdrževalcev | Ni pravila. Kdo postane vzdrževalec projekta, odločajo skrbniki wikija; po katerem merilu, ni določeno. |
Posledice
Če pišete dokumentacijo za to področje, za drugo tabelo ne smete oblikovati pravila. Izmišljeno pravilo je tu dražje od manjkajočega: videti je kot odločitev, kot odločitev se tudi navaja, nikogar pa ne zavezuje.
Navodila Oddaja spremembe zato opisujejo samo to, kar platforma dejansko omogoča, odprta vprašanja pa poimenujejo, namesto da bi jih zapolnila.
Odločitev o odprtem vprašanju vpiše v prvo tabelo tisti, ki jo sprejme: navede dokaz in prilagodi navodila, ki jih odločitev zadeva.