Leiðarvísir frá Naglasúpunni
Gátlisti fyrir fyrsta framlag þitt til hugbúnaðarverkefnis
Veldu fyrsta framlag sem þú getur útskýrt í einni setningu og lokið með skýrum skilum. Lestu leiðbeiningar verkefnisins, staðfestu að verkið sé vel þegið, gerðu minnstu gagnlegu breytinguna og lýstu því hvernig þú kannaðir hana.
Uppfært
Kynntu þér verkefnið áður en þú velur verk
Lestu lýsinguna og prófaðu þann hluta sem vekur áhuga þinn. Ef tengt er á kóðasafn skaltu leita að README-skrá, leiðbeiningum fyrir þátttakendur, opnum verkum og samskiptareglum. Athugaðu hvort einhver sé þegar að vinna að því sem þú ætlar að leggja til.
Til dæmis er tengill á kóðasafn Naglasúpunnar í síðufæti þessa vefs. Leiðbeiningarnar þar eru upphafspunktur fyrir vinnu við þennan vettvang. Ekki gera ráð fyrir að önnur verkefni noti sömu tækni eða verkferla. Þótt verkefni hafi ekkert opinbert kóðasafn getur þú mögulega hjálpað með villulýsingu eða yfirferð á viðmóti.
Skilgreindu eina niðurstöðu og spurðu hvort hún hjálpi
Góð fyrstu verk hafa sýnilegan endi: endurtaka eina villu, skýra eitt uppsetningarskref eða prófa einn skjá í þröngum glugga. Forðastu víðtæka endurskrifun áður en þú þekkir forsendur verkefnisins.
Sendu stutta tillögu: „Í uppsetningarleiðbeiningunum kemur ekki fram hvaða skipun ræsir framendann. Ég get prófað núverandi skref og lagt til litla textabreytingu. Myndi það hjálpa og er einhver þegar að vinna í þessu?“
Umsjónaraðilinn gæti stungið upp á öðru verki. Skýrt umfang frá upphafi sparar báðum aðilum yfirferð. Ef ekkert svar berst skaltu velja annað skráð verk eða verkefni í stað þess að gera ráð fyrir samþykki fyrir stórri breytingu.
Skilaðu einhverju sem hægt er að yfirfara
Fylgdu skilaleið verkefnisins. Fyrir kóðabreytingu skaltu nota skjalfestar skipanir fyrir þróun og prófanir. Í villulýsingu skaltu nefna umhverfið, skref til að endurtaka vandann, vænta niðurstöðu og raunverulega niðurstöðu. Fyrir leiðbeiningar skaltu prófa breyttu skrefin frá upphafspunkti lesandans.
Notaðu þennan gátlista við skil:
- Lýstu vandanum og tengdu á samþykkta verkið ef það er skráð.
- Útskýrðu breytinguna eða athugunina í fáeinum setningum.
- Lýstu þeim prófunum sem þú framkvæmdir í raun.
- Nefndu það sem er ólokið eða óvíst.
- Spyrðu afmarkaðrar spurningar ef þú þarft ákvörðun frá yfirlesara.
Haltu einkaupplýsingum utan skjámynda og annála sem þú birtir opinberlega.
Svaraðu yfirferðinni og veldu næsta skref
Líttu á athugasemdir við yfirferð sem upplýsingar um þarfir verkefnisins. Biddu um skýringu ef breytingabeiðni er óljós og segðu frá því ef hún krefst meiri tíma en þú getur boðið. Umsjónaraðilinn ákveður hvort verkið sé samþykkt; innsending tryggir ekki að það verði tekið inn.
Þegar verkinu er lokið skaltu skrá leiðbeiningar sem vantaði og gætu hjálpað næsta nýliða. Þú getur látið þar við sitja eða samið um annað lítið verk. Sjá nánara samhengi í leiðarvísi GitHub um framlög til opins hugbúnaðar. Ef þú vilt lengra samstarf skaltu gera ábyrgðina skýra með samstarfslýsingu.
Viltu benda á leiðréttingu eða gagnlegt dæmi? Hafðu samband.