Skip to content

Tworzenie Tasków w Github

Wymagania obowiązkowe

Aby task został poprawnie utworzony i przetworzony przez system, musi spełniać następujące wymagania:

1. Komentarz w formacie Markdown

Task musi zawierać komentarz opisujący zadanie w formacie Markdown. Komentarz powinien zawierać:

  • Jasny opis zadania do wykonania
  • Wymagania techniczne (jeśli dotyczy)
  • Kontekst biznesowy (jeśli potrzebny)
  • Przykłady lub referencje (jeśli dostępne)

2. Labelka cg

Task musi być oznaczony labelką cg, która identyfikuje go jako zadanie do automatycznego przetwarzania przez system generowania kodu.

Przykład poprawnego taska

Markdown
# Implementuj walidację formularza logowania

## Zadanie
Zaimplementuj walidację formularza logowania w komponencie LoginForm.

## Wymagania
- Walidacja emaila (format, wymagane pole)
- Walidacja hasła (minimum 8 znaków, wymagane pole)
- Wyświetlanie błędów walidacji
- Blokowanie wysłania formularza przy błędach

## Technologie
- Angular 17
- Reactive Forms
- Custom validators

Labelki: cg, cg-agent-auto

Opis kroków:

  1. Utworzenie taska - Użytkownik tworzy task w Jira z wymaganymi elementami
  2. Sprawdzenie wymagań - System weryfikuje obecność komentarza Markdown, labelki cg
  3. Wykrycie taska - System automatycznie wykrywa gotowy do przetworzenia task
  4. Analiza - System analizuje komentarz Markdown i określa wymagania
  5. Generowanie kodu - System generuje kod zgodnie ze specyfikacją
  6. Utworzenie MR - System tworzy Merge Request z wygenerowanym kodem
  7. Status Done - Task zostaje oznaczony jako zakończony
  8. Przegląd MR - Użytkownik sprawdza wygenerowany kod
  9. Modyfikacje - Jeśli potrzebne są zmiany, użytkownik dodaje komentarz do taska
  10. Ponowne przetwarzanie - System wykrywa nowy komentarz i ponownie przetwarza task
  11. Aktualizacja - Kod jest modyfikowany i MR jest aktualizowany

Cykl iteracyjny

System obsługuje cykl iteracyjny, gdzie użytkownik może wielokrotnie dodawać komentarze do taska, a system będzie automatycznie modyfikował kod i aktualizował MR, dopóki rezultat nie będzie satysfakcjonujący.

Rozszerzenie taska o dodatkowe zasoby

Task można rozszerzyć o dodatkowe zasoby, które pomogą systemowi lepiej zrozumieć wymagania:

Pliki

  • Link: Dokumentacja plików
  • Opis: Dodanie referencji do zalacznikow w tasku
  • Korzyści: System może analizować dodatkowe pliki

Obrazy

  • Link: Dokumentacja obrazów
  • Opis: Dodanie obrazów z mockupami, diagramami lub przykładami
  • Korzyści: Wizualne wsparcie dla zrozumienia wymagań i kontekstu

Figma

  • Link: Dokumentacja Figma
  • Status: 🔴 W trakcie przygotowania
  • Opis: Integracja z Figma dla automatycznego generowania kodu na podstawie designów
  • Uwaga: Obecnie nie zalecana do użycia w taskach produkcyjnych

Przykład rozszerzonego taska

Komentarz

Markdown
# Implementuj walidację formularza logowania

## Zadanie
Zaimplementuj walidację formularza logowania w komponencie LoginForm.

## Wymagania
- Walidacja emaila (format, wymagane pole)
- Walidacja hasła (minimum 8 znaków, wymagane pole)
- Wyświetlanie błędów walidacji
- Blokowanie wysłania formularza przy błędach

## Technologie
- Angular 17
- Reactive Forms
- Custom validators

## Zasoby
- Design: https://figma.com/file/example
- Referencja: `referencje.md`
- Mockup: `mockup.png`

Labelki: cg, cg-agent-auto