Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

67 lines (42 loc) · 2.93 KB

Contribution Guidelines

Za brži, lakši i bezbolniji doprinos projektu, molim vas da slijedite ove smjernice.

Preduvjeti

Prije nego što započnete s doprinosima projektu, osigurajte da imate instaliran Git na vašem računalu.

0. Dohvat projekta

  1. Otvorite naredbeni redak ili terminal na svom računalu.

  2. Navigirajte do mjesta na kojem želite smjestiti projekt.

  3. Klonirajte projekt iz repozitorija koristeći naredbu git clone:

    git clone https://github.com/AlexIchenskiy/burek.git

  4. Smjestite se u radni folder projekta:

    cd burek

Sada ste spremni za rad na projektu.

1. Grananje (Branching)

U našem projektu koristimo tri glavna brancha:

  • master: Ovo je glavni branch koji sadrži stabilnu verziju projekta za deployment i release-ove.
  • dev: Razvojni branch gdje se nalazi najnovija verzija aplikacije.
  • devdoc: Branch za dokumentaciju.

Kako biste započeli rad na novoj korisničkoj priči (User Story), stvorite novi branch s nazivom u sljedećem formatu: TIP-BROJ-Kratki-opis, gdje:

  • TIP je vrsta priče (npr. BEUS ili FEUS).
  • PRIČA je broj korisničke priče.
  • Kratki-opis je kratak opis onoga što ste napravili u sklopu te korisničke priče.

npr. BEUS-1-Add-login

2. Commitovi

VAŽNO: Ako radite grupno, prije svake promjene dohvatite zadnju verziju koda (git pull) kako bi izbjegli konflikte.

Koristimo commit poruke prema konvencijama. Nakon unesenih promjena u kod trebate ih dodati u staging (git add), commit-ati (git commit -m "poruka") te push-ati u vaš branch.

Naprimjer, git add *, git commit -m "feat: add login endpoint" te git push origin BEUS-1-Add-login.

Detaljnije o git-u i svim naredbama možete pročitati ovdje.

3. Pull Requests

Kada završite rad na svojom branch-u i spremni ste za integraciju u dev, slijedite ove korake:

  1. Stvorite pull request sa svojeg branch-a u dev.
  2. Naziv pull request-a mora biti sličan nazivu branch-a. Na primjer: "BEUS 1: Add login".
  3. U opisu pull request-a ne morate ništa pisati, ali možete ostaviti dodatne komentare za svoje kolege.
  4. Dodajte sebe (i po potrebi osobu s kojom surađujete) kao assignee pull request-a te mene (i druge koji su relevantni) kao reviewer-e.
  5. Nema obaveznih oznaka (labels).

4. Recenzija i Testiranje

Nakon što stvorite pull request, imate opciju čekati da ga netko recenzira i testira ili ga sami možete merge-ati ako ste sigurni u svoj kod. Međutim, preporučujem da čekate na recenziju i testiranje od strane drugih članova tima kako biste osigurali kvalitetu koda.

Hvala što ste doprinijeli našem projektu!

Ako imate bilo kakvih pitanja ili trebate pomoć, slobodno se obratite meni.