From 73282266138807bbfa6ff79f1c7f3742b1a82bd3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johan=20T=C3=B6tterman?= Date: Thu, 26 Feb 2015 17:12:58 +0200 Subject: [PATCH] Pulkkarin dokumentointiohjeet Pulkkarin dokumentointiohjeet --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 291e9b7c1b..c6fd374235 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,13 @@ # Pull Request * Pidä huoli, että ominaisuutesi branch on ajantasalla kun teet Pull Requestin. -* Pull Requestin otsikon tulee selkeästi kuvata muutos. Otsikon maksimipituus 50 merkkiä. +* Pull Requestin otsikon tulee selkeästi kuvata muutos. + * Pidä otsikko lyhyenä. Otsikon maksimipituus 50 merkkiä. + * Viittaa otsikossa vain siihen ohjelmaan / asiaan jota pulkkarissa käsitellään. Otsikossa ei tarvitse yrittää kertoa mitä uutta on tehty ja/tai korjattu. * Pull Requestin kommentissa tulee kuvata ominaisuus tarkemmin. Kommenttiriveillä ei ole maksimipituutta. + * Kirjoita ohjelman loppukäyttäjän näkökulmasta, ei koodaajan eikä koodin näkökulmasta, mitä ollaan tehty. + * Kun korjataan jokin juttu, niin kerro mikä asia missä ohjelmassa meni ennen väärin ja miten se nyt korjattuna toimii. + * Kun tehdään uusi ominaisuus, niin kerro loppukäyttäjän näkökulmasta mitä uutta pupeen on tehty ja miten ominaisuus otetaan käyttöön sekä lyhyesti miten ominaisuus toimii. * Tarvittaessa siisti branchisi commitit ennen Pull Requestiä `git rebase -i master`. # Commit