Hej nybörjare,
Grattis till att göra din väg till öppen källkod. Det är ett bra samhälle.
det är lite förvirrande i början. Hur man bidrar, var att bidra, problem, buggar, PR, PR, PR!
oroa dig inte, eftersom du blir involverad i öppen källkod lär du dig allt.
men idag vill jag ge er alla några råd som jag aldrig fick när jag började min resa med öppen källkod.
jag började bidra till öppen källkod och sätta alla mina små sidoprojekt på GitHub för ett tag sedan., Då visste jag inte om README-delen. Tiden gick och jag började följa några kickass Utvecklare. Utan tvekan hade de alla fantastiska projekt men det vanligaste var, alla sina projekt hade fantastisk README och det är hur jag kom att veta om vikten av en bra README.
stopp!! Jag är inte intresserad av att läsa om din resa med öppen källkod. Berätta bara om hur man skriver en bra README.
Cool. Så här går du —
innan du börjar sätta dina fantastiska projekt på GitHub, jag vill att du ska gå och läsa om Readme Driven utveckling först.,
varför ska jag bry mig om en README?
open source community växer snabbt. Utvecklare släpper ut nya open-source-projekt på GitHub varje dag. Som ett resultat blir det allt svårare att få ditt eget projekt att sticka ut från havet av öppen källkod. Du kan dock göra några saker för att öka dina chanser att ta tag i andra utvecklarens uppmärksamhet. En effektiv och enkel teknik sätter upp en snygg och hjälpsam README-fil.
din README bör vara lika bra som ditt projekt., En stor README-fil hjälper ditt projekt att sticka ut från havet av öppen källkod på GitHub.
en README är som ansiktet på ditt projekt. Det är den första filen en person bör läsa när möter en källa träd, och det bör skrivas som en mycket kort och ger mycket grundläggande introduktion till programvaran.
ett projekt utan README är inte så användbart. Låt oss ta en titt på detta projekt, till exempel.
ingen README, ingen beskrivning, inget ingenting. Du kommer inte att få någon aning om vad den här killen byggt, oavsett hur häftigt det är.,
låt oss nu ta en titt på det här projektet. Författaren har nämnt detaljerade och tydliga instruktioner om projektet och därmed lättare för andra att använda och prova.
en fin README är ett bra sätt att hjälpa människor att engagera sig i projektet också. Ett projekt med fin README och skärmdumpar kommer att få användarnas uppmärksamhet bättre eftersom det är ett direkt sätt att förklara varför detta projekt är viktigt och varför människor ska använda och bidra till projektet. Good README bör också innehålla tillräckligt med information för att hjälpa en ny användare att komma igång, t. ex., hur man sammanställer, hur man installerar och hur man börjar integrera.
Ok. Nog prata. Visa mig hur man skriver en bra README då.
nu när du håller med om att README betyder något, ska jag berätta hur du skriver en. Det är inte så svårt. Du behöver bara hålla fast vid några kulpunkter. Här är några av de punkter du bör ha i åtanke när du skriver en README.
formatering av README?,
nu när du har lärt dig hur och vad du ska skriva i en README, låt oss prata lite om styling av README aka formatering.
formatering är en viktig del av README. Du kan lära dig om hur du formaterar din README härifrån och här.
i slutändan, kom ihåg —
du behöver inte gå fullbordat Readme Driven utveckling, du behöver inte inkludera alla dessa punkter , du behöver inte följa någon särskild process. Men att skriva en bra README kommer definitivt att förbättra dina dokumentationskunskaper som gör dig till en bättre utvecklare.,
Leave a Reply