Osallistuminen

Tee yksi pieni muutos oikeaan paikkaan ja lähetä se pull requestina.

Ennen kuin aloitat

• Avaa ensin issue tai kommentoi olemassa olevaa. Kerro, mitä haluat muuttaa ja miksi.
• Odota vastausta, ettet rakenna jotain, mitä ei hyväksytä.
• Käy läpi Käyttöönotto, jotta voit rakentaa ja ajaa HolyArrsin.

Kysymykset menevät Discordiin. Ideat menevät r/HolyArrsiin. Issuet on tarkoitettu virheille ja roadmapille.

Lähetä ensimmäinen pull requestisi

1. Etsi moduuli, johon muutoksesi kuuluu. Sivun Moduulit nimet vastaavat kansioiden nimiä, joten väärä Discord-ilmoitus on muutos alerts-moduuliin.

2. Tee muutos kansioihin app/backend/internal/<module>/ ja app/frontend/src/lib/<module>/. Pidä se yhdessä korjauksessa tai yhdessä ominaisuudessa.

3. Rakenna verkkosovellus ja sitten ohjelma, ja kokeile muutosta selaimessa. Katso Käyttöönotto.

4. Aja tarkistukset sivulta Testaus.

   Virheitä ei pitäisi tulla.

5. Jos muutit sivua, aja sen end-to-end-projekti, esimerkiksi npm --prefix app/frontend run e2e -- --project=movies.

6. Avaa pull request. Linkitä issue, kerro mitä muuttui ja miten testasit, ja lisää tai päivitä muutoksen testit.

7. Ensimmäisessä pull requestissasi botti pyytää sinua allekirjoittamaan osallistujan lisenssisopimuksen (CLA). Vastaa yhdellä lauseella, jota se pyytää.

Huomio

Pidät omasta työstäsi tekijänoikeuden. Sopimus mahdollistaa sen, että HolyArrsia voi tarjota AGPL-3.0-lisenssillä ja kaupallisella lisenssillä. Kaikki yhdistetty koodi pysyy saatavilla myös AGPL-3.0-lisenssillä. Teksti on tiedostossa .github/CLA.md.

Vaihtoehdot

Minne muutos kuuluu

Muutos	Mene tänne
Uusi reitti	Moduulit
Uusi moduuli	Moduulit. Avaa ensin issue
Myöhemmäksi jätetty ominaisuus	Käyttöönotto
Versio	Julkaiseminen. Vain projektin ylläpitäjille

Millainen on hyvä pull request

• Kirjoita kommentit, jotka kertovat, miksi koodi tekee sen mitä tekee. Ei roadmap-numeroita, päivämääriä, nimiä eikä pitkiä ajatusviivoja kommenteissa.
• Älä koske sovelluksen sanamuotoihin, ellei issue koske sanamuotoja.
• Jätä julkaistut API-polut, kenttien nimet, asetusavaimet, taulujen nimet ja tehtävien nimet ennalleen. Lisää, älä koskaan nimeä uudelleen.

Jos se ei toimi

Oire. Rakennetarkistus epäonnistuu. Syy. Virheilmoitus nimeää tiedoston ja säännön. Ratkaisu. Siirrä koodi tai välitä tavallista dataa ylemmältä moduulilta. Katso Moduulit.

Oire. Verkkosovellus näyttää vanhalta. Syy. Ohjelma tarjoaa sen buildin, jonka se on upottanut itseensä. Ratkaisu. Rakenna verkkosovellus uudelleen ennen ohjelmaa.

Oire. End-to-end-testit eivät käynnisty. Syy. Testiselainta ei ole asennettu. Ratkaisu. Suorita npx --prefix app/frontend playwright install chromium.

Asiantuntijoille

Säännöt, joita pull requestin on noudatettava

• Moduuli puhuu toiselle moduulille vain sen palvelun (Go) tai sen index.ts-tiedoston (web) kautta. Ei koskaan sen storen tai tiedostojen kautta.
• SQL on vain moduulin store*.go-tiedostoissa, ja vain moduulin omiin tauluihin.
• Web-osa menee kansioon lib/ui vain, jos sitä käyttää vähintään 2 moduulia.
• Ei util-, common-, shared- eikä helpers-paketteja.
• Jokainen ulkoinen kutsu kulkee core/outbound-paketin kautta.

Testit tarkistavat nämä säännöt, joten väärä import kaataa buildin. Koko lista ja tarkistusten nimet ovat sivulla Moduulit.

Mitä CI ajaa

Tehtävä	Ajaa
Web	check, lint, test, build ja end-to-end-sarja
Go	go build, go vet ja go test -timeout 60m ./... arkkitehtuureilla amd64 ja arm64, natiivisti ja emuloinnissa
Race	go test -race ./...
Sopimus	openapi.json-vastaavuus, oikeusaluetarkistukset jokaiselle reitille, latausohjelmien sarja
Vika ja mittakaava	Kaatumis-, hidaskirjoitus-, viallinen ulkoinen palvelu- ja muistiajot
Image	Kehitysimage rakentuu, käynnistyy ja ilmoittaa versionsa

Pitkien ajojen yksityiskohdat ovat sivulla Testaus.

Aiheesta lisää

• Käyttöönotto
• Testaus
• Arkkitehtuuri