Prispievanie¶

Ďakujeme za váš záujem prispieť do GitPulse! Táto stránka popisuje proces a konvencie pre prispievanie.

Proces prispievania¶

graph LR
    FORK["Fork repozitára"] --> BRANCH["Vytvor branch"]
    BRANCH --> CODE["Napíš kód"]
    CODE --> TEST["Testy"]
    TEST --> PR["Merge Request"]
    PR --> REVIEW["Code Review"]
    REVIEW --> MERGE["Merge"]

Rýchly štart¶

1. Fork a klonovanie¶

1
2

git clone https://git.kpi.fei.tuke.sk/kpi-zp/2027/dp.mykyta.olym/workspace/workspace.git gitpulse
cd gitpulse

2. Vytvorenie branch¶

1
2
3
4
5
6
7

# Synchronizácia s upstream
git fetch upstream
git checkout main
git merge upstream/main

# Nový feature branch
git checkout -b feature/moj-novy-feature

3. Vývoj¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# Nastavenie prostredia
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

# Spustenie testov
pytest

# Linting
ruff check .
ruff format .

4. Commit a push¶

1
2
3

git add .
git commit -m "feat: pridanie novej funkcionality"
git push origin feature/moj-novy-feature

5. Merge Request¶

Otvorte MR cez GitLab UI s popisom zmien.

Konvencie¶

Branch naming¶

Commit messages¶

Používame Conventional Commits:

1
2
3
4
5

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Typy¶

Príklady¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

# Feature
feat(gaming): pridanie detekcie commit burstov

# Fix
fix(api): oprava 500 error pri prázdnom team

# Docs
docs(readme): aktualizácia inštalačných inštrukcií

# Breaking change
feat(api)!: zmena formátu response pre /metrics

BREAKING CHANGE: response teraz obsahuje nested objekt metrics

Code style¶

Python¶

Používame Ruff pre linting a formátovanie.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

# pyproject.toml
[tool.ruff]
line-length = 100
target-version = "py312"

[tool.ruff.lint]
select = [
    "E",    # pycodestyle errors
    "W",    # pycodestyle warnings
    "F",    # Pyflakes
    "I",    # isort
    "B",    # flake8-bugbear
    "UP",   # pyupgrade
]

[tool.ruff.lint.isort]
known-first-party = ["app"]

Príklad dobre formátovaného kódu¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

"""Team service module.

This module provides business logic for team management.
"""
from datetime import datetime
from typing import Sequence

from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession

from app.models.team import Team
from app.schemas.team import TeamCreate, TeamUpdate


class TeamService:
    """Service for team-related operations."""

    def __init__(self, db: AsyncSession) -> None:
        """Initialize team service.

        Args:
            db: Async database session.
        """
        self.db = db

    async def get_all(self, course_id: int) -> Sequence[Team]:
        """Get all teams for a course.

        Args:
            course_id: The course ID to filter by.

        Returns:
            List of teams belonging to the course.
        """
        result = await self.db.execute(
            select(Team)
            .where(Team.course_id == course_id)
            .order_by(Team.name)
        )
        return result.scalars().all()

Testy¶

Každá nová funkcionalita musí mať testy.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# tests/unit/test_team_service.py
import pytest
from app.services.team_service import TeamService


class TestTeamService:
    """Tests for TeamService."""

    @pytest.fixture
    def service(self, db_session):
        return TeamService(db_session)

    @pytest.mark.asyncio
    async def test_get_all_returns_teams_for_course(
        self, service, sample_course, sample_team
    ):
        """get_all should return only teams for specified course."""
        # Arrange
        course = await sample_course()
        team1 = await sample_team(course=course)
        team2 = await sample_team(course=course)

        # Act
        teams = await service.get_all(course.id)

        # Assert
        assert len(teams) == 2
        assert all(t.course_id == course.id for t in teams)

Code Review¶

Čo hľadáme¶

• Kód je čitateľný a dobre dokumentovaný
• Testy pokrývajú novú funkcionalitu
• Žiadne breaking changes bez dokumentácie
• Commit messages sú popisné
• CI pipeline prechádza

Tipy pre autora MR¶

1. Malé MR - Ľahšie sa reviewujú
2. Popisný title - Jasne vysvetľuje čo MR robí
3. Screenshots - Pre UI zmeny
4. Self-review - Prejdite si diff pred odoslaním

Tipy pre reviewera¶

1. Konštruktívna kritika - Navrhujte riešenia
2. Prioritizácia - Odlíšte blocker vs nice-to-have
3. Testovanie - Checkout branch a vyskúšajte
4. Approve promptly - Neblokujte progress

Issues¶

Vytvorenie issue¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

## Popis
Krátky popis problému alebo požiadavky.

## Kroky na reprodukciu (pre bugy)
1. Krok 1
2. Krok 2
3. ...

## Očakávané správanie
Čo by sa malo stať.

## Aktuálne správanie
Čo sa deje namiesto toho.

## Prostredie
- OS: Ubuntu 22.04
- Python: 3.12.1
- GitPulse verzia: 2026.5.17.post3

Labels¶

Development workflow¶

Feature development¶

sequenceDiagram
    participant Dev as Developer
    participant Git as Git
    participant CI as GitLab CI
    participant Rev as Reviewer

    Dev->>Git: push to feature branch
    Git->>CI: trigger pipeline
    CI->>CI: lint, test, build
    CI-->>Git: pipeline status
    Dev->>Git: create MR
    Git->>Rev: request review
    Rev->>Git: approve / request changes
    Dev->>Git: address feedback
    Rev->>Git: approve
    Dev->>Git: merge to main

Release process¶

graph LR
    MAIN["main branch"] --> |tag v2026.5.17.post3| RELEASE["Release"]
    RELEASE --> |"CI/CD"| DEPLOY["Deploy to staging"]
    DEPLOY --> |manual approval| PROD["Deploy to production"]

Kontakt¶

• Maintainer: Mykyta Olym
• GitLab Issues: Pre bugy a feature requests
• MS Teams: Pre rýchle otázky

Ďalšie čítanie¶

• Lokálne prostredie
• Štruktúra projektu
• Testovanie