Przejdź do treści

STD-PROC-001 · Struktura plików w repozytorium

1. Cel

Zapewnić, że każde repozytorium organizacji zawiera kompletny zestaw plików metadanych umożliwiających orientację nowym współpracownikom, licencjonowanie kodu oraz prowadzenie historii zmian.

2. Zakres

Dotyczy wszystkich repozytoriów z kodem lub dokumentacją zarządzanych w grupie dev.rachuna. Nie dotyczy repozytoriów archiwizowanych (archived: true).

3. Wymagania (normatywne)

  • R1. Repozytorium MUSI zawierać plik README.md w katalogu głównym.
  • R2. Repozytorium MUSI zawierać plik CODEOWNERS definiujący właścicieli obszarów kodu.
  • R3. Repozytorium MUSI zawierać plik CHANGELOG.md generowany automatycznie przez semantic-release na podstawie commitów (STD-PROC-003).
  • R4. Repozytorium MUSI zawierać plik LICENSE określający warunki licencji.
  • R5. Repozytorium MUSI zawierać plik CONTRIBUTING.md opisujący sposób wnoszenia wkładu.
  • R6. Repozytorium MUSI zawierać plik CODE_OF_CONDUCT.md określający zasady współpracy.
  • R7. Repozytorium MUSI zawierać plik .gitlab/footer.md — stopka interfejsu GitLab.
  • R8. Repozytorium MUSI zawierać plik .gitlab/badges.md — odznaki wyświetlane w README.
  • R9. Repozytorium MUSI zawierać plik .gitlab/avatar.png — avatar projektu.
  • R10. Repozytorium MUSI zawierać plik .gitignore.

4. Minimum of Done

  • Czy istnieje plik README.md w katalogu głównym?
  • Czy istnieje plik CODEOWNERS w katalogu głównym?
  • Czy istnieje plik CHANGELOG.md w katalogu głównym?
  • Czy istnieje plik LICENSE w katalogu głównym?
  • Czy istnieje plik CONTRIBUTING.md w katalogu głównym?
  • Czy istnieje plik CODE_OF_CONDUCT.md w katalogu głównym?
  • Czy istnieje plik .gitlab/footer.md?
  • Czy istnieje plik .gitlab/badges.md?
  • Czy istnieje plik .gitlab/avatar.png?
  • Czy istnieje plik .gitignore?

Weryfikacja: bash standards/proces/STD-PROC-001/bin/checks.sh

5. Implementacja — dobra praktyka (informacyjne, niewiążące)

  • README.md — opis projektu, quickstart, linki do dokumentacji.
  • CODEOWNERS — mapowanie ścieżek na zespoły; każdy MR dostaje automatycznych recenzentów.
  • CHANGELOG.md — generowany przez semantic-release przy każdym tagu; nie edytuj ręcznie. Szczegóły: STD-PROC-004.
  • LICENSE — dla repozytoriów wewnętrznych: licencja własna organizacji lub CC BY-NC-SA 4.0.
  • CONTRIBUTING.md — jak zgłaszać bugi, jak tworzyć MR, standardy commitów (link do STD-PROC-003).
  • CODE_OF_CONDUCT.md — zalecany Contributor Covenant 2.1.
  • .gitlab/ — pliki konfiguracyjne interfejsu GitLab; skopiuj z repozytorium dyscypliny (STD-PROC-006).

6. Referencje

STD-PROC-003 Conventional Commits · STD-PROC-006 Stopka repozytorium · Keep a Changelog · Contributor Covenant.