Panustamine

Tee üks väike muudatus õiges kohas ja saada see pull request’ina.

Enne alustamist

• Ava esmalt issue või kommenteeri olemasolevat. Kirjuta, mida tahad muuta ja miks.
• Oota vastust, et sa ei ehitaks midagi, mida ei liideta.
• Lõpeta Seadistamine, et saaksid HolyArrsi ehitada ja käivitada.

Küsimused lähevad Discordi. Ideed lähevad r/HolyArrsi. Issue’d on vigade ja teekaardi jaoks.

Saada oma esimene pull request

1. Leia moodul, kuhu su muudatus kuulub. Nimed lehel Moodulid vastavad kaustanimedele, nii et vale Discordi teavituse parandus on muudatus moodulis alerts.

2. Tee muudatus kaustades app/backend/internal/<module>/ ja app/frontend/src/lib/<module>/. Hoia see ühe parandusena või ühe funktsioonina.

3. Ehita veebirakendus, siis programm, ja proovi muudatust brauseris. Vaata Seadistamine.

4. Käivita kontrollid lehelt Testimine.

   Ühtegi viga ei tohiks tulla.

5. Kui muutsid lehte, käivita selle otsast otsani projekt, näiteks npm --prefix app/frontend run e2e -- --project=movies.

6. Ava pull request. Lingi issue, kirjuta, mis muutus ja kuidas testisid, ning lisa või uuenda muudatuse teste.

7. Esimese pull request’i juures palub bot sul allkirjastada panustaja litsentsileping. Vasta ühe lausega, mida ta küsib.

Note

Sinu töö autoriõigus jääb sulle. Leping lubab HolyArrsi pakkuda AGPL-3.0 all ja kommertslitsentsi all. Kõik liidetud jääb kättesaadavaks ka AGPL-3.0 all. Tekst on failis .github/CLA.md.

Valikud

Kuhu muudatus läheb

Muudatus	Mine siia
Uus marsruut	Moodulid
Uus moodul	Moodulid. Ava esmalt issue
Edasi lükatud funktsioon	Seadistamine
Versioon	Versiooni avaldamine. Ainult hooldajatele

Milline on hea pull request

• Kirjuta kommentaarid, mis ütlevad, miks kood teeb seda, mida ta teeb. Kommentaarides ei ole teekaardi numbreid, kuupäevi, nimesid ega mõttekriipse.
• Jäta rakenduse sõnastus rahule, kui issue pole sõnastusest.
• Hoia välja antud API teed, väljade nimed, seadete võtmed, tabelinimed ja tööülesannete nimed samaks. Lisa, ära kunagi nimeta ümber.

Kui see ei tööta

Sümptom. Struktuurikontroll ebaõnnestub. Põhjus. Teade nimetab faili ja reegli. Lahendus. Tõsta kood ära või anna lihtsad andmed kõrgemast moodulist alla. Vaata Moodulid.

Sümptom. Veebirakendus näeb vana välja. Põhjus. Programm teenindab sisse ehitatud versiooni. Lahendus. Ehita veebirakendus uuesti enne programmi.

Sümptom. Otsast otsani testid ei käivitu. Põhjus. Testbrauser ei ole paigaldatud. Lahendus. Käivita npx --prefix app/frontend playwright install chromium.

Asjatundjale

Reeglid, mida pull request peab järgima

• Moodul räägib teise mooduliga ainult selle teenuse (Go) või selle index.ts (veeb) kaudu. Mitte kunagi selle store’i ega failide kaudu.
• SQL asub ainult mooduli store*.go failides, mooduli enda tabelite kohal.
• Veebiosa läheb kausta lib/ui ainult siis, kui seda kasutab 2 või rohkem moodulit.
• Ei mingeid util, common, shared ega helpers pakette.
• Iga väljapoole suunatud päring käib läbi core/outbound.

Testid kontrollivad neid reegleid, nii et vale import rikub ehituse. Täielik loend ja kontrollide nimed on lehel Moodulid.

Mida CI käivitab

Töö	Käivitab
Web	check, lint, test, build ja otsast otsani testikomplekt
Go	go build, go vet ja go test -timeout 60m ./... platvormidel amd64 ja arm64, natiivselt ja emulatsioonis
Race	go test -race ./...
Contract	openapi.json vastavus, õiguste kontrollid igal marsruudil, allalaadijate komplekt
Fault and scale	Kokkujooksmise, aeglase kirjutamise, vigase välisteenuse ja mälu jooksutused
Image	Arenduse image ehitub, käivitub ja teatab oma versiooni

Pikkade jooksutuste üksikasjad on lehel Testimine.

Seotud lehed

• Seadistamine
• Testimine
• Arhitektuur