Hé kezdők,
gratulál a nyílt forráshoz való eljutáshoz. Ez egy nagyszerű közösség.
Ez egy kicsit zavaró a kezdő. Hogyan lehet hozzájárulni, hol lehet hozzájárulni, kérdések, hibák, PR, PR, PR!
ne aggódjon, mivel részt vesz a nyílt forráskódban, mindent meg fog tanulni.
de ma szeretnék adni néhány tanácsot, amelyet soha nem kaptam meg, amikor elkezdtem a nyílt forráskódú utazást.
elkezdtem hozzájárulni a nyílt forráshoz, és egy ideje az összes apró mellékprojektemet a githubra helyeztem., Akkoriban nem tudtam a README részről. Eltelt az idő, és elkezdtem követni néhány kickass fejlesztőt. Nem kétséges, hogy mindegyiknek csodálatos projektjei voltak, de az egyik leggyakoribb dolog az volt, hogy minden projektjüknek fantasztikus README volt, így tudtam meg a jó README fontosságát.
állj!! Nem érdekel a nyílt forráskódú utazásod. Csak mondd el, hogyan kell írni egy jó README.
Cool. Tehát itt megy –
mielőtt elkezdené üzembe a félelmetes projektek GitHub, azt akarom, hogy menjen, és olvassa el Readme vezérelt fejlesztés első.,
miért érdekel a README?
a nyílt forráskódú közösség gyorsan növekszik. A fejlesztők minden nap kiadnak új nyílt forráskódú projekteket a GitHub-on. Ennek eredményeként egyre nehezebb megszerezni a saját projektjét, hogy kitűnjön a nyílt forráskódú szoftverek tengeréből. Néhány dolgot azonban megtehet, hogy növelje esélyét arra, hogy megragadja más Fejlesztő figyelmét. Egy hatékony és egyszerű technika üzembe egy szép megjelenésű, hasznos README fájlt.
a README legyen olyan jó, mint a projekt., Egy nagyszerű README fájl segít a projektnek abban, hogy kitűnjön a GitHub nyílt forráskódú szoftverének tengeréből.
a README olyan, mint a projekt arca. Ez az első fájl, amelyet egy személynek el kell olvasnia, amikor egy forrásfával találkozik, és nagyon rövidnek kell lennie, és nagyon alapvető bevezetést kell adnia a szoftvernek.
a readme nélküli projekt nem olyan hasznos. Vessünk egy pillantást erre a projektre, például.
nincs README, nincs leírás,nincs semmi. Fogalmad sem lesz, mit épített ez a fickó, nem számít, milyen félelmetes.,
most vessünk egy pillantást erre a projektre. A szerző részletes és világos utasításokat említett a projektről, így mások könnyebben használhatják és kipróbálhatják.
egy szép README egy jó módja annak, hogy segítsen az embereknek részt venni a projektben is. A projekt szép README és screenshotok lesz a figyelmet a felhasználók jobb, mivel ez egy közvetlen módja annak, hogy miért ez a projekt számít, és miért az emberek kell használni, és hozzájárulnak a projekthez. A jó README-nek elegendő részletet kell tartalmaznia ahhoz, hogy segítsen egy új felhasználónak az indulásban, például, hogyan kell összeállítani, hogyan kell telepíteni, Hogyan kell elkezdeni az integrációt.
Ok. Elég a dumából. Mutasd meg, hogyan kell írni egy jó README akkor.
most, amikor egyetért azzal, hogy a README számít, elmondom, hogyan kell írni egyet. Nem olyan nehéz. Csak meg kell ragaszkodni néhány golyó pontokat. Íme néhány pont, amelyet szem előtt kell tartania a README írása közben.
a README formázása?,
most, hogy megtanítottad magadnak, hogyan és mit kell írni egy README-ben, beszéljünk egy kicsit a README más néven formázás stílusáról.
A formázás a README lényeges része. A README formázásáról itt és itt olvashat.
végül ne feledje –
nem kell teljes furatú Readme-vezérelt fejlesztést folytatnia , nem kell tartalmaznia az összes golyópontot, nem kell követnie egy adott folyamatot. De egy jó README írása minden bizonnyal javítja a dokumentációs készségeket, amelyek jobb fejlesztővé teszik Önt.,
Leave a Reply