6 Posebni fajlovi

U ovom poglavlju biće opisani fajlovi koji se nalaze u korisničkom repozitorijumu, a to su fajl za instrukcije i uputstva (eng. Readme file) i fajl za doprinos projektu (eng. Contributing).

Fajl za instrukcije i uputstva - Readme fajl

Jedan od najčešćih fajlova koji se koristi na GitHub platformi je fajl za instrukcije i uputstva, a on se nalazi u formatu koji platforma GitHub prepoznaje kao tekst, kao što su README, README.md, README.asciidoc itd. Uglavnom se ovaj fajl nalazi na početnoj stranici projekta.

U fajlu za instrukcije i uputstva se nalaze sve bitne informacije o projektu za korisnika koji se prvi put susreće sa repozitorijumom ili projektom. Obično se pišu sledeće stvari:

• šta je namena projekta,
• kako ga konfigurisati i instalirati,
• primer koji pokazuje kako se koristi ili kako se pokreće,
• licenca pod kojom je projekat dostupan,
• kako se daje doprinos projektu.

GitHub platforma prikazuje ovaj fajl, a dodatno se mogu postaviti slike ili linkovi kako bi se olakšalo razumevanje samog dokumenta.

Doprinos projektu - fajl Contributing

Fajl koji se bavi doprinosom projektu (eng. Contributing) daje osnovne informacije potencijalnim saradnicima projekta o tome kako mogu da pomognu projektu. Njega platforma GitHub prepoznaje, kao i fajl za instrukcije i uputstva. Osnovna ideja ovog fajla je da autor koda eksplicitno navede šta treba, odnosno šta ne treba da bude deo zahteva za povlačenje. Kadgod postoji fajl za doprinos projektu, GitHub će nuditi opciju otvaranja zahteva za povlačenje, ukoliko korisnik otvori zahtev za povlačenje.