|
| 1 | +# Audit & Improvement Plan |
| 2 | + |
| 3 | +## PR 1 — Modernizacja CI |
| 4 | +**Branch:** `ci/modernize-workflows` |
| 5 | +**Commit:** `ci: modernize GitHub Actions workflows` |
| 6 | + |
| 7 | +- `ContinuousIntegration.yml`: `checkout@v2` → `checkout@v4`, `macos-latest` → `macos-15`, dodać `swift test` |
| 8 | +- `swiftlint.yml`: `checkout@v1` → `v4`, zaktualizować `norio-nomura/action-swiftlint` |
| 9 | + |
| 10 | +--- |
| 11 | + |
| 12 | +## PR 2 — Naprawa SwiftLint |
| 13 | +**Branch:** `fix/swiftlint-config` |
| 14 | +**Commit:** `fix: repair SwiftLint configuration` |
| 15 | + |
| 16 | +- Usunąć `Sources` z `excluded` (cały kod źródłowy jest wyciszony) |
| 17 | +- Usunąć zduplikowany klucz `excluded:` |
| 18 | +- Podnieść lub usunąć `line_length: 140` |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +## PR 3 — Aktualizacja wersji Swift |
| 23 | +**Branch:** `chore/update-swift-version` |
| 24 | +**Commit:** `chore: align Swift version across configuration files` |
| 25 | + |
| 26 | +- `.swift-version`: `5.5` → `6.1` |
| 27 | +- `Package.swift`: `swift-tools-version: 5.10.0` → `6.1` |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## PR 4 — Migracja Preview API |
| 32 | +**Branch:** `refactor/preview-macro` |
| 33 | +**Commit:** `refactor: migrate previews from PreviewProvider to #Preview macro` |
| 34 | + |
| 35 | +- `SlidableImage.swift`, `Arrows.swift`, `Triangle.swift`: zamienić przestarzałe `PreviewProvider` na `#Preview {}` |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +## PR 5 — Zastąpienie Jazzy przez DocC |
| 40 | +**Branch:** `ci/replace-jazzy-with-docc` |
| 41 | +**Commit:** `ci: replace Jazzy documentation with DocC` |
| 42 | + |
| 43 | +- Usunąć `PublishDocumentation.yml` |
| 44 | +- Dodać `docs.yml` (DocC + GitHub Pages via Actions) |
| 45 | +- Zmienić Pages source na `workflow` |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +## PR 6 — Testy |
| 50 | +**Branch:** `test/add-unit-tests` |
| 51 | +**Commit:** `test: add test target and unit tests` |
| 52 | + |
| 53 | +- Dodać `testTarget` do `Package.swift` |
| 54 | +- Pokryć testami: obliczenia maski, boundary conditions, inicjalizacje |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## PR 7 — README |
| 59 | +**Branch:** `docs/improve-readme` |
| 60 | +**Commit:** `docs: rewrite README with accurate content and examples` |
| 61 | + |
| 62 | +- Naprawić literówkę `Instalation` → `Installation` |
| 63 | +- Zaktualizować badge CI |
| 64 | +- Dodać badge Swift Package Index |
| 65 | +- Rozszerzyć przykłady użycia |
| 66 | +- Dodać link do dokumentacji (po PR 5) |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +## Kolejność realizacji |
| 71 | + |
| 72 | +``` |
| 73 | +PR 1, PR 2, PR 3 ← równolegle |
| 74 | + ↓ |
| 75 | + PR 4, PR 6 |
| 76 | + ↓ |
| 77 | + PR 5 |
| 78 | + ↓ |
| 79 | + PR 7 |
| 80 | +``` |
0 commit comments