| zasady dla deweloperów |  |
Definicje
- kod - całość oprogramowania Nutch wraz z dokumentacją.
- deweloper - członek niewielkiej grupy, która może bezpośrednio
zmieniać kod.
- kontrybutor - ktoś, kto przekazuje kod dla projektu Nutch pośrednio
poprzez dewelopera
- licencja - licencja znajdująca się w pliku LICENSE.txt.
- organizacja - właściciel praw do kodu Nutch.
Proces Podejmowania Decyzji
Wszystkie decyzje w projekcie podejmowane są zwykłą większością głosów
wszystkich deweloperów. Głosy wysyłane są emailem na listę dyskusyjną dev@nutch.org.
Generalnie rzecz biorąc, projekt Nutch działa w oparciu o kilku
aktywnych deweloperów, którzy ufają sobie nawzajem. W związku z tym
większość zmian może byc wprowadzana jednomyślnie, bez oficjalnej
autoryzacji.
W szczególności:
- Sam proces decyzyjny może zostać zmieniony zwykłą większością
głosów.
- Deweloperzy są dodawani lub usuwani zwykłą większością głosów
pozostałych deweloperów.
- Różnice zdań co do konkretnych zmian kodu rozwiązywane są
zwykłą większością głosów istniejących deweloperów.
Proces Wprowadzania Zmian
Deweloperzy zawsze powinni przeprowadzić rekompilację kodu według
najnowszej wersji kodu pobranej z CVS. Kompilacja powinna zakończyć się
pomyślnie, i bez ostrzegawczych komunikatów. Tworzenie Javadoc powinno
nie dawać żadnych ostrzegawczych komunikatów. Wszystkie testy JUnit
muszą zakończyć się sukcesem zanim kod zostanie wprowadzony do
oficjalnej wersji.
Innymi słowy, należy podjąć następujące kroki przed każdym "cvs commit":
cvs update -d
ant clean test javadoc
Mamy również system codziennej automatycznej kompilacji źródeł, który wysyła
emailem powiadomienia dla deweloperów w przypadku błędów.
Kontrybucje
Zachęcamy wszystkich, którzy nie są oficjalnymi deweloperami,
do wspierania projektu przez raportowanie i poprawianie błędów, oraz
implementowanie nowej funkcjonalności.
Kontrybucje muszą:
- być wysyłane na listę dyskusyjną dev@nutch.org.
- być w formacie "patch" (np. przez użycie
cvs diff -Nu)
- odpowiadać stylowi kodowania przyjętemu w projekcie
- używać licencji projektu Nutch
- przekazać prawa własności dla organizacji Nutch.
Styl kodowania
Kod źródłowy Java powinien stosować się do stylu opisanego w:
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
Wszystkim modułom powinny towarzyszyć testy JUnit.
Każdej klasie, metodzie i polu "public" lub "protected" musi towarzyszyć pomocny
komentarz Javadoc.
|
