Doprinos
Vodič za doprinos WvdS FPC RAD Suite projektu.
Dobrodošli
Hvala vam na interesu za doprinos WvdS FPC RAD Suite projektu! Ovaj dokument objašnjava kako možete podnijeti doprinose.
Preduvjeti
Razvojno okruženje
Znanja
Vrste doprinosa
Prijave grešaka
Provjerite je li greška već prijavljena
Stvorite Issue s:
Zahtjevi za značajke
Opišite željenu značajku
Objasnite slučaj korištenja
Skicirajte moguće implementacije
Doprinosi koda
Forkajte repozitorij
Stvorite feature-branch
Implementirajte promjenu
Testirajte lokalno
Stvorite Pull Request
Standardi koda (kratki pregled)
Obavezno
Nema TODO/
- Potpune implementacije
Komentari na engleskom - PasDoc format za javne
API-je
Konvencije imenovanja - TWvdS* za klase, IWvdS* za sučelja
i18n - Bez hardkodiranih stringova, koristite Resourcestrings
Zabranjeno
TypeScript/ručno pisani JavaScript
Prazni exception handleri
Magic Numbers
SQL string konkatenacija
Hardkodirani podaci za prijavu
Preporučeno
Nazivi unitova: WvdS.<Kategorija>.<Komponenta>.pas
Funkcije: 12-24 retka, maks. 40
Parametri: maks. 5-7
DRY: Bez duplikacije koda
Proces Pull Requesta
1. Priprema
# Forkajte i klonirajte repozitorij
git clone https://github.com/VASE-KORISNICKO-IME/WvdS.FPC.git
cd WvdS.FPC
# Stvorite feature-branch
git checkout -b feature/moja-znacajka
2. Implementacija
Pišite kod prema standardima
Testirajte (kompilacija, testiranje ekstenzije)
Commitovi s jasnim porukama
3. Pull Request
4. Review
Revieweri će dati povratne informacije
Prilagodite promjene prema potrebi
Nakon odobrenja slijedi merge
Kontrolna lista prije Pull Requesta
[ ] Kod se kompilira bez grešaka
[ ] Ekstenzija funkcionira u testu
[ ] Nema TODO/FIXME komentara
[ ] Javni API-ji su dokumentirani
[ ] Nema hardkodiranih stringova
[ ] Nema Magic Numbers
[ ] Testovi prolaze (ako postoje)
[ ] CHANGELOG.md ažuriran (kod novih značajki)
Komunikacija
Issues: Prijave grešaka, zahtjevi za značajke
Pull Requests: Diskusije o kodu
Discussions: Opća pitanja
Licenca
Podnošenjem doprinosa pristajete da se vaši doprinosi objave pod istom licencom kao projekt.
Za tehničke detalje
Kontakt
Vidi također