Hei aloittelijoille,
Onnittelut tekeminen tapa avata lähde. Se on hieno yhteisö.
lähtö on hieman hämmentävä. Miten osallistua, missä osallistua, kysymyksiä, vikoja, PR, PR,PR!
älä huoli, kun osallistut avoimeen lähdekoodiin opit kaiken.
Mutta tänään haluaisin antaa sinulle joitakin neuvoja, joita en koskaan saanut kun aloitin avoimen lähdekoodin matka.
aloin edistää avointa lähdekoodia ja laittaa kaikki pienet sivuprojektini GitHubiin jokin aika sitten., Silloin en tiennyt README-osasta. Aika kului ja aloin seurata joitakin kickass Kehittäjät. Epäilemättä heillä kaikilla oli uskomattomia projekteja,mutta yksi yleisin asia oli, kaikki heidän projektinsa olivat mahtavia README ja siten opin tuntemaan hyvän README.
STOP!! En halua lukea avoimen lähdekoodin matkastasi. Kerro vain, miten kirjoittaa hyvä README.
Cool. Joten tässä teille —
Ennen kuin voit aloittaa laittamalla mahtava hankkeiden GitHub, haluan sinun mennä ja lukea Readme-Driven Development ensin.,
miksi lukema kiinnostaisi?
Avoimen lähdekoodin yhteisö kasvaa nopeasti. Kehittäjät julkaisevat uusia avoimen lähdekoodin projekteja GitHubilla joka päivä. Tämän seurauksena on yhä vaikeampaa saada oma projekti erottumaan avoimen lähdekoodin ohjelmistojen merestä. Kuitenkin, voit tehdä muutamia asioita lisätä mahdollisuuksiasi tarttua muiden Kehittäjä huomiota. Yksi tehokas ja yksinkertainen tekniikka on mukavan näköinen ja hyödyllinen README-tiedosto.
READMEN pitäisi olla yhtä hyvä kuin projektisi., Suuri README-tiedosto auttaa projektia erottumaan GitHub-ohjelmiston merestä.
README on kuin projektin Kasvot. Se on ensimmäinen tiedosto, henkilö pitäisi lukea, kun kohdataan lähde puu, ja se pitäisi kirjoittaa niin hyvin lyhyt ja antaa hyvin perus käyttöön ohjelmiston.
projekti ilman README ei ole niin hyödyllinen. Katsotaan esimerkiksi tätä projektia.
no README, no description, no nothing. Et tajua, mitä hän rakensi, vaikka se olisi kuinka mahtava.,
nyt katsotaan tätä projektia. Kirjoittaja on mainittu, yksityiskohtaiset ja selkeät ohjeet projektista ja siten helpottaa muiden käyttää ja kokeilla sitä.
mukava README on hyvä tapa auttaa ihmisiä sitoutumaan hankkeeseen sekä. Hankkeen mukava README ja kuvakaappauksia saada huomiota käyttäjiä paremmin, koska se on suora tapa selittää, miksi tämä projekti asioissa, ja miksi ihmisten pitäisi käyttää ja osallistua hankkeeseen. Hyvän READMEN tulisi myös sisältää tarpeeksi yksityiskohtia, jotta uusi käyttäjä pääsee alkuun, esim., miten koota, miten asentaa, ja miten aloittaa integrointi.
Ok. Riittää jo. Näytä minulle, miten kirjoittaa hyvä README sitten.
nyt kun olet samaa mieltä, että READMELLA on väliä, niin kerron, miten sellainen kirjoitetaan. Ei se ole niin vaikeaa. Sinun täytyy vain pitää kiinni luodeista. Tässä muutamia kohtia sinun pitäisi pitää mielessä kirjoittaessasi README.
Muotoilu-LUEMINUT-tiedosto?,
Nyt kun olet opettanut itse, miten ja mitä kirjoittaa README, puhutaanpa vähän siitä, muotoilu README aka muotoilua.
Muotoilu on olennainen osa README. Voit oppia muokkaamaan README-ohjelmaasi täältä ja täältä.
lopulta, Pitää mielessä, —
Sinun ei tarvitse mennä koko reiän Readme-Driven Development, sinun ei tarvitse sisällyttää kaikki ne bullet pistettä , sinun ei tarvitse seurata mitään tiettyä prosessia. Mutta kirjoittaminen hyvä README varmasti parantaa dokumentointitaitojasi, mikä tekee sinusta paremman kehittäjän.,
Leave a Reply