Współpraca w projekcie open source OTOBO

OTOBO to projekt typu open source dostępny w organizacji GitHub RotherOSS (https://github.com/RotherOSS/otobo). Jeśli chcesz zgłaszać błędy lub przekazywać własny kod, postępuj zgodnie z poniższym procesem:

---

1. Proces pracy na GitHubie

1.1 Fork i klonowanie

1. Utwórz fork repozytorium https://github.com/RotherOSS/otobo.
2. Sklonuj swojego forka lokalnie:

   git clone https://github.com/<twój-użytkownik>/otobo.git
   cd otobo

### 1.2 Tworzenie gałęzi

Dla każdej zmiany utwórz nową gałąź:

```bash
git checkout -b feature/<krótki-opis>

Przykład:

git checkout -b feature/add-hello-world-module

1.3 Commit i push

1. Zaimplementuj swój kod.

2. Dodaj czytelne komunikaty commitów:

   git add .
   git commit -m "Dodaje moduł HelloWorld z podstawową funkcjonalnością"

3. Wypchnij swoją gałąź:

   git push origin feature/add-hello-world-module

1.4 Pull Request

1. Otwórz swojego forka na GitHubie.
2. Kliknij Compare & pull request.
3. W opisie PR krótko wyjaśnij, co Twoja funkcja lub poprawka robi i dlaczego jest ważna.
4. Wybierz odpowiednią docelową gałąź (zazwyczaj master lub development).

---

2. Styl kodu i testy

2.1 CodePolicy

RotherOSS używa narzędzia CodePolicy (https://github.com/RotherOSS/CodePolicy) do sprawdzania standardów kodowania.

• Instalacja:

  cpanm CodePolicy

• Uruchomienie w katalogu głównym repozytorium:

  CodePolicy --check .

2.2 Moduły Perl i dokumentacja POD

• Każdy moduł typu Kernel::System::* oraz Kernel::Modules::* musi zawierać dokumentację w formacie POD.
• Zadeklaruj zależności w zmiennej our @ObjectDependencies.
• Upewnij się, że zawierają linie use strict; use warnings;.

2.3 Testy jednostkowe

OTOBO wykorzystuje testy oparte na Mojolicious oraz [Test::More]. Umieść swoje testy w katalogu t/:

prove -l t/MyModule.t

---

3. Zarządzanie zgłoszeniami i recenzje

3.1 Otwieranie zgłoszeń (issues)

• Najpierw poszukaj istniejących zgłoszeń.
• Utwórz nowe zgłoszenie z tytułem, krokami odtworzenia problemu, logami i zrzutami ekranu (jeśli potrzebne).

3.2 Etykiety i szablony

• Używaj etykiet bug, enhancement, question.
• Postępuj zgodnie z szablonami zgłoszeń i pull requestów dostępnymi w repozytorium.

3.3 Recenzje kodu

• Szybko odpowiadaj na komentarze w PR.
• Dodawaj testy lub poprawiaj styl, jeśli recenzenci tego zażądają.
• Po zatwierdzeniu Twój PR zostanie scalony.

---

4. Społeczność i wsparcie

• Dyskusje na GitHubie: https://github.com/RotherOSS/otobo/discussions
• Lista mailingowa i czat: Linki znajdziesz na https://otobo.com/ w sekcji „Community”.
• Dokumentacja: Dokumentacja dla programistów dostępna na https://doc.otobo.org/ („How to Contribute”).

Powodzenia podczas tworzenia OTOBO!