Współtworzenie w projekcie Open Source OTOBO

OTOBO jest projektem Open Source pod organizacją GitHub RotherOSS (https://github.com/RotherOSS/otobo). Jeśli chcesz zgłaszać błędy lub wnosić własny kod, postępuj zgodnie z tym przepływem pracy:

---

1. Przepływ pracy GitHub

1.1 Fork & Clone

1. Utwórz fork https://github.com/RotherOSS/otobo.
2. Skopiuj swój fork lokalnie:

   git clone https://github.com/<twoj-user>/otobo.git
   cd otobo

1.2 Tworzenie gałęzi (Branching)

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

git checkout -b feature/<krotki-opis>

Przykład:

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

1.3 Commit & Push

1. Zaimplementuj swój kod.

2. Dodaj sensowne komunikaty commitów:

   git add .
   git commit -m "Adds HelloWorld module with basic functionality"

3. Wypchnij swoją gałąź:

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

1.4 Pull Request

1. Otwórz swój fork na GitHubie.
2. Kliknij Compare & pull request.
3. Opisz krótko w tekście PR, co robi Twoja funkcja/poprawka błędu i dlaczego jest ważna.
4. Wybierz właściwą gałąź docelową (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 głównym katalogu repozytorium:

  CodePolicy --check .

2.2 Moduły Perla i POD

• Każdy moduł Kernel::System::* i Kernel::Modules::* musi zawierać dokumentację POD.
• Deklaruj zależności w our @ObjectDependencies.
• Zwróć uwagę na use strict; use warnings;.

2.3 Testy jednostkowe

OTOBO używa testów Mojolicious i [Test::More]. Umieść swoje testy w katalogu t/:

prove -l t/MyModule.t

---

3. Zarządzanie zgłoszeniami i przeglądy

3.1 Otwieranie zgłoszeń (Issues)

• Najpierw poszukaj istniejących zgłoszeń.
• Utwórz zgłoszenie z tytułem, krokami do reprodukcji, logami i zrzutami ekranu (jeśli to konieczne).

3.2 Etykiety i szablony

• Używaj etykiet bug, enhancement, question.
• Postępuj zgodnie z szablonami zgłoszeń i PR w repozytorium.

3.3 Przeglądy kodu

• Odpowiadaj na komentarze dotyczące przeglądu w PR w odpowiednim czasie.
• Dodaj testy lub zmień styl, jeśli sugerują to recenzenci.
• Po zatwierdzeniu Twój PR zostanie scalony.

---

4. Społeczność i wsparcie

• GitHub Discussions: https://github.com/RotherOSS/otobo/discussions
• Lista mailingowa i czat: Linki znajdziesz na https://otobo.com/ w sekcji „Community”.
• Dokumentacja: Dokumentacja dla deweloperów na https://doc.otobo.org/ („How to Contribute”).

Powodzenia we współtworzeniu OTOBO!