# Proces pracy

Strona opisuje wspólny proces pracy nad kodem we wszystkich repozytoriach Logintegry. Jest dla programistów i recenzentów. Pliki `CONTRIBUTING.md` w repozytoriach odsyłają tutaj i opisują tylko własne wyjątki.

## Zgłoszenia

Każda zmiana w kodzie ma zgłoszenie w YouTrack, a jego numer, np. `A-19163`, jest kluczem całej pracy.

| Projekt YouTrack | Zastosowanie |
| --- | --- |
| `A` | zadania i błędy Apollo |
| `DEV` | prośby o zmiany w dokumentacji, zgłaszane przyciskami pod stronami |
| `TMA` | przypadki testowe, opisane w [Przypadki testowe w TMA](<https://docs.logintegra.com/testy-tma/index.md>) |
| `CONA` | konfiguracje w ramach zadań |
| `INF` | zadania w projekcie infokiosku |
| `MSC` | zadania w projekcie mikroserwisu kurierskiego |
| `MPS` | zadania w projekcie projekcie mikroserwisu parsującego |

## Branche

Każde repozytorium ma główny branch wskazany w `repos.txt`, czyli `develop` albo `master`. Zmianę robimy na osobnym branchu nazwanym numerem zgłoszenia, np. `A-19163`. Gdy do jednego zgłoszenia potrzeba kilku branchy, dopisujemy kolejny numer po kropce, np. `A-18905.2`.

Branch wychodzi z głównego brancha repozytorium i do niego wraca. Branche `release` i `hotfix` obowiązują wszystkie repozytoria. Nazwa brancha `release` albo `hotfix` zawiera numer wersji aplikacji w postaci `release-X.Y.Z` albo `hotfix-X.Y.Z`, np. `release-4.173.0`.

## Git flow

Git flow opisuje artykuł [Workflow Git, release, testy](<https://youtrack.logintegra.com/articles/DEV-A-139/Workflow-Git-release-testy>) w YouTrack. Ta sekcja jest jego streszczeniem.

Celem jest ograniczenie wzajemnego blokowania się zespołów. Opóźnienie jednego zespołu nie powinno wymuszać synchronizacji i retestów u innych.

### Zasady

1. Bieżąca praca trafia na `develop`, a release stabilizujemy osobno na `release-X.Y.Z`. Codzienna integracja i przygotowanie release nie odbywają się na tym samym branchu, co ogranicza konflikty.
2. Pracujemy na krótkich branchach zadaniowych, a nie na długo żyjących branchach zespołowych.
3. Preferujemy małe pull requesty i częsty merge do `develop`.
4. Release nie czeka na koniec sprintu. Wydajemy to, co jest gotowe i bezpieczne, a resztę przenosimy do kolejnego tygodnia.

### Cykl release

| Termin | Co się dzieje |
| --- | --- |
| czwartek, 12:00 | odcięcie `release-X.Y.Z` z `develop` i zamrożenie zakresu zmian |
| po zamrożeniu | do `release-X.Y.Z` trafiają tylko wyjątki |
| środa | release |

Wyjątki to poprawki błędów blokujących i krytyczne zmiany techniczne. Nowy kod trafia przez cały czas na `develop`, więc zamrożenie dotyczy tylko brancha release.

### Bramki do develop

Merge do `develop` wymaga:

- builda
- analizy statycznej
- testów jednostkowych
- review według sekcji "Pull request"

Większość tych bramek trzeba jeszcze wdrożyć (TODO). Selenium nie blokuje merge do `develop`, bo jest za wolne i niestabilne.

### Testy Selenium

Selenium pilnuje przede wszystkim release. Testy dzielimy tagami, żeby szybciej dostawać sensowny wynik.

| Tag | Zakres |
| --- | --- |
| `@quarantine` | testy niestabilne, wyłączone z ochrony release |

Test, który regularnie daje fałszywe alarmy, trafia do `@quarantine` i dostaje zadanie do naprawy.

### Testy ręczne

Testy ręczne mają dwa poziomy. Zespoły i ich QA sprawdzają swoje zmiany na bieżąco. Przed wydaniem robimy akceptację release na osobnym środowisku.

## Commity

Komunikat commita staramy się pisać według [Conventional Commits 1.0.0](<https://www.conventionalcommits.org/en/v1.0.0/>). Język komunikatu jest dowolny. Jeden commit opisuje jedną zmianę. "Refs: A-XXXX" oznacza odwołanie do zadania YT, które commit rozwiązuje.

```
feat: customowe hosty w swagger ui Refs: A-12345
```

## Pull request

Branch trafia do głównego brancha przez pull request w Bitbucket. Tytuł pull requesta zawiera numer zgłoszenia. Po zatwierdzeniu Bitbucket tworzy merge commit `Merged in A-19142 (pull request #8852)`.

Pull request MUSI mieć zatwierdzenie dwóch recenzentów. Recenzenci MUSZĄ należeć do zespołów Apollo.

Pull request MUSI przejść bramki z sekcji "Bramki do develop" (TODO). Zakres PR checków opisuje [plan CI](<https://docs.logintegra.com/plan-ci/index.md>).

Pull request z kodem zawiera, gdy dotyczy to zmiany:

- testy zmienionego zachowania
- komentarze dokumentacyjne według zasad 36–46 z [Zasad dokumentacji](<https://docs.logintegra.com/zasady-dokumentacji/index.md>)
- zmianę stron dokumentacji, jeśli zmiana opisuje inne zachowanie niż strona
