Ahoj začátečníci,
Gratulujeme k tomu, abyste se dostali k open source. Je to skvělá komunita.
na začátku je to trochu matoucí. Jak přispět, kam přispět, problémy, chyby, PR, PR, PR!
nebojte se, protože se zapojíte do open source, naučíte se to všechno.
ale dnes bych vám rád dal všechny rady, které jsem nikdy nedostal, když jsem začal svou cestu s otevřeným zdrojovým kódem.
začal jsem přispívat k open source a dávat všechny své malé vedlejší projekty na GitHub před chvílí., Tehdy jsem o té části README nevěděl. Čas plynul a začal jsem sledovat některé vývojáře kickass. Není pochyb o tom, že všichni měli úžasné projekty, ale jedna nejčastější věc byla, všechny jejich projekty měly úžasné README a tak jsem se dozvěděl o důležitosti dobrého README.
STOP!! Nemám zájem číst o vaší cestě s otevřeným zdrojovým kódem. Jen mi řekni, jak napsat dobrý README.
Cool. Takže tady jdete –
než začnete dávat své úžasné projekty na GitHub, chci, abyste nejprve šli a přečetli si o vývoji readme Driven.,
proč bych se měl starat o README?
open source komunita rychle roste. Vývojáři vydávají každý den nové open-source projekty na Githubu. V důsledku toho je stále obtížnější získat svůj vlastní projekt, aby vynikl z moře open-source softwaru. Můžete však udělat několik věcí, abyste zvýšili své šance na upoutání pozornosti ostatních vývojářů. Jedna efektivní a jednoduchá technika je uvedení do pěkně vypadající a užitečné readme soubor.
váš README by měl být stejně dobrý jako váš projekt., Skvělý soubor README pomáhá vašemu projektu vyniknout z moře open-source softwaru na Githubu.
README je jako tvář vašeho projektu. Je to první soubor, který by měl člověk číst při setkání se zdrojovým stromem, a měl by být napsán jako velmi stručný a velmi základní úvod do softwaru.
projekt bez README není tak užitečný. Podívejme se například na tento projekt.
No README, no description, no nothing. Nebudete mít tušení, co ten chlap postavil, bez ohledu na to, jak úžasné to je.,
nyní se podívejme na tento projekt. Autor zmínil podrobné a jasné pokyny k projektu, a proto je pro ostatní jednodušší jej používat a vyzkoušet.
pěkný README je dobrý způsob, jak pomoci lidem zapojit se do projektu, jakož. Projekt s pěknou README a screenshoty získat pozornost uživatele lepší, protože to je přímý způsob, jak vysvětlit, proč tento projekt věcech, a proč by lidé měli používat a přispívat do projektu. Dobrý README by měl také obsahovat dostatek podrobností, které pomohou novému uživateli začít, např., jak kompilovat, jak nainstalovat a jak začít integrovat.
Ok. Dost řečí. Ukažte mi, jak napsat dobrý README pak.
nyní, když souhlasíte s tím, že README záleží, řeknu vám, jak napsat jeden. Není to tak těžké. Stačí se držet některých odrážek. Zde jsou některé z bodů, které byste měli mít na paměti při psaní README.
Formátování v README?,
Nyní, když jste se naučili, jak a co psát v README, promluvme si trochu o stylu formátování README aka.
formátování je nezbytnou součástí README. Zde a zde se můžete dozvědět, jak formátovat README.
nakonec, Mějte na paměti,
nemusíte jít naplno Readme Driven Development, nemusíte zahrnovat všechny ty body , nemusíte dodržovat žádné zvláštní proces. Ale psaní dobrého README určitě zlepší vaše dovednosti v oblasti dokumentace, díky nimž budete lepším vývojářem.,
Leave a Reply