Prejsť na obsah
Accquix Register
Esc
↑↓navigácia↵otvoriť⌘Jnáhľad
Na tejto stránke

Ako prispieť

Ako zostaviť, otestovať a navrhnúť zmeny, a pravidlá, ktoré udržia projekt správny.

Accquix Register sa vyvíja otvorene na GitHube.

Ako fungujú príspevky

Accquix Register je open source a udržiava ho Accquix. Hlásenia chýb aj pull requesty sú vítané. Projekt sa však vyvíja predovšetkým pre potreby infraštruktúry Accquix a Accquix si ponecháva plné právo rozhodovať o jeho smerovaní a o tom, ktoré príspevky prijme.

  • Pred väčšou zmenou otvorte issue, aby sme vám mohli povedať, či zapadá do projektu, skôr ako jej venujete čas. Drobné opravy môžu ísť rovno do pull requestu.
  • Nemôžeme sľúbiť, že každé issue alebo pull request dostane odpoveď alebo bude prijatý.
  • Forky sú vítané. Licencia Apache-2.0 vám umožňuje prevádzkovať, upravovať a šíriť vlastnú verziu.
  • Bezpečnostné zraniteľnosti: nikdy nie vo verejnom issue. Postupujte podľa SECURITY.md.
  • GitHub Discussions nepoužívame; otázky k inštalácii a správaniu riešte cez issues.

Základné pravidlá

  • Len kód, nikdy dáta. Testy používajú syntetické dáta: vymyslené mená, IČO v rozsahu 9990xxxx a DIČ v rozsahu 20999xxxxx, ktoré v registroch neexistujú.
  • Najprv si prečítajte rozhodnutia. docs/decisions.md je záväzný; zmenu navrhnite v issue, nie obídením v kóde. Otvorené otázky sú v docs/open-questions.md.
  • Identifikátory sú presné, neaktuálne zrkadlo nikdy nepovie „nenájdené“ a logy neobsahujú dopyty ani identifikátory.

Vývoj s pomocou AI

Veľkú časť projektu píšu AI agenti pod vedením a kontrolou správcov. Hovoríme to otvorene. Príspevky vytvorené s pomocou AI sú vítané za rovnakých pravidiel: za to, čo odovzdáte, zodpovedáte vy, musí to prejsť testami a musíte to vedieť vysvetliť.

Zostavenie a testy

Potrebujete Go 1.27+ a Docker.

docker run -d --name register-test-pg -p 5432:5432 -e POSTGRES_PASSWORD=test postgres:18
export REGISTER_TEST_DATABASE_URL="postgres://postgres:test@localhost:5432/postgres?sslmode=disable"
go test ./...

Pred pull requestom:

gofmt -l .                                                   # nesmie nič vypísať
go vet ./...
golangci-lint run ./...
go run ./cmd/accquix-register openapi > api/openapi.yaml     # keď sa zmení API

Táto dokumentácia

Web je v priečinku site/ a zostavuje ho Blume. API referencia sa generuje z api/openapi.yaml, takže sa nemôže rozísť s kódom.

cd site && npm install && npm run dev

Anglické stránky sú v site/docs/, slovenské v site/docs/sk/ s rovnakými názvami súborov.

Commity

Každý commit podpíšte (DCO, bez CLA) a používajte Conventional Commits:

git commit -s -m "fix: …"

Bezpečnostné problémy hláste súkromne, ako uvádza SECURITY.md.