Hei incepatori,
felicitări pentru a face drumul spre open source. E o comunitate grozavă.
este un pic confuz la început. Cum să contribuiți, unde să contribuiți, probleme, bug-uri, PR, PR, PR!
nu vă faceți griji, deoarece vă implicați în open source, veți învăța totul.
dar astăzi aș vrea să vă dau tuturor câteva sfaturi pe care nu le-am primit niciodată când am început călătoria mea open source.
am început să contribui la open source și să pun toate proiectele mele mici pe GitHub cu ceva timp în urmă., Atunci nu știam de partea cu README. Timpul a trecut și am început să urmez niște Dezvoltatori kickass. Fără îndoială că toate au avut proiecte uimitoare, dar cel mai comun lucru a fost, toate proiectele lor au avut README minunat și așa am ajuns să știu despre importanța unui README bun.
oprește-te!! Nu mă interesează să citesc despre călătoria ta open source. Doar spune-mi despre cum să scrie un README bun.
rece. Înainte de a începe să vă puneți proiectele minunate pe GitHub, vreau să mergeți și să citiți mai întâi despre dezvoltarea Readme Driven.,de ce ar trebui să-mi pese de un README?
comunitatea Open source crește rapid. Dezvoltatorii lansează noi proiecte open-source pe GitHub în fiecare zi. Drept urmare, devine din ce în ce mai dificil să obțineți propriul proiect pentru a ieși în evidență de Marea software-ului open-source. Cu toate acestea, puteți face câteva lucruri pentru a crește șansele de a atrage atenția altor dezvoltatori. O tehnică eficientă și simplă este punerea unui fișier README cu aspect frumos și util.
README-ul dvs. ar trebui să fie la fel de bun ca proiectul dvs., Un mare fișier README ajută proiectul să iasă în evidență din Marea de software open-source pe GitHub.
un README este ca fața proiectului. Acesta este primul fișier o persoană ar trebui să citească atunci când se confruntă cu un copac sursă, și ar trebui să fie scris ca un foarte scurt și oferind introducere foarte de bază la software-ul.
un proiect fără README nu este atât de util. Să aruncăm o privire la acest proiect, de exemplu.
nu README, nici o descriere, nici nimic. Nu veți avea nicio idee despre ce a construit tipul ăsta, indiferent cât de minunat este.,
acum să aruncăm o privire la acest proiect. Autorul a menționat instrucțiuni detaliate și clare despre proiect și, prin urmare, mai ușor pentru alții să-l folosească și să-l încerce.
un README frumos este o modalitate buna de a ajuta oamenii să se angajeze în proiect, de asemenea. Un proiect cu README frumos și capturi de ecran va atrage atenția utilizatorilor mai bine, deoarece este o modalitate directă de a explica de ce acest proiect contează și de ce oamenii ar trebui să folosească și să contribuie la proiect. README bun ar trebui să includă, de asemenea, suficiente detalii pentru a ajuta un nou utilizator începe, de exemplu., cum se compilează, cum se instalează și cum se începe integrarea.
Ok. Gata cu vorbăria. Arată-mi cum să scrie un bun README atunci.acum, după cum sunteți de acord că README contează, vă voi spune cum să scrieți unul. Nu este atât de dificil. Trebuie doar să rămâi cu câteva puncte de glonț. Iată câteva dintre punctele pe care ar trebui să le țineți cont în timp ce scrieți un README.
Formatarea README?,acum că v-ați învățat cum și ce să scrieți într-un README, să vorbim puțin despre stilul de formatare README aka.formatarea este o parte esențială a README. Puteți afla despre cum să formatați README de aici și aici.în cele din urmă, rețineți —
nu trebuie să mergeți la dezvoltarea Readme , nu trebuie să includeți toate acele puncte de glonț, nu trebuie să urmați niciun proces special. Dar scrierea unui README bun vă va îmbunătăți cu siguranță abilitățile de documentare, ceea ce vă va face un dezvoltator mai bun.,
Leave a Reply