Hey beginners,
gefeliciteerd met het maken van je weg naar open source. Het is een geweldige gemeenschap.
Het is een beetje verwarrend in het begin. Hoe bij te dragen, waar bij te dragen, problemen, bugs, PR, PR, PR!
maak je geen zorgen, als je jezelf betrokken raakt bij open source zul je het allemaal leren.
maar vandaag wil ik jullie wat advies geven dat ik nooit heb ontvangen toen ik mijn open source reis begon.
Ik begon een tijdje geleden bij te dragen aan open source en al mijn kleine zijprojecten op GitHub te zetten., Toen wist ik niets van het README gedeelte. De tijd verstreek en ik begon enkele kickass ontwikkelaars te volgen. Zonder twijfel hadden ze allemaal geweldige projecten, maar het meest voorkomende was, al hun projecten hadden geweldige README en dat is hoe ik kwam te weten over het belang van een goede README.
stoppen!! Ik ben niet geïnteresseerd in het lezen over je open source reis. Vertel me hoe ik een goede README moet schrijven.
Cool. Dus hier ga je —
voordat je je geweldige projecten op GitHub gaat zetten, wil ik dat je eerst gaat lezen over Readme Driven Development.,
waarom zou ik geven om een README?
Open source gemeenschap groeit snel. Ontwikkelaars brengen elke dag nieuwe open-source projecten op GitHub uit. Als gevolg hiervan wordt het steeds moeilijker om je eigen project te onderscheiden van de zee van open-source software. Echter, kunt u een paar dingen doen om uw kansen op het grijpen van de aandacht van andere ontwikkelaar te verhogen. Een effectieve en eenvoudige techniek is het opzetten van een mooi uitziende en nuttige README-bestand.
uw README zou net zo goed moeten zijn als uw project., Een geweldig README-bestand helpt uw project om zich te onderscheiden van de zee van open-source software op GitHub.
een README is als het gezicht van uw project. Het is het eerste bestand dat een persoon zou moeten lezen wanneer hij een broncode-boom tegenkomt, en het zou geschreven moeten worden als een zeer korte en zeer eenvoudige introductie tot de software.
een project zonder README is niet zo nuttig. Laten we eens kijken naar dit project, bijvoorbeeld.
geen README, geen beschrijving, Geen niets. Je krijgt geen idee wat hij heeft gebouwd, hoe geweldig het ook is.,
laten we nu eens kijken naar dit project. De auteur heeft gedetailleerde en duidelijke instructies over het project genoemd en dus gemakkelijker voor anderen om het te gebruiken en uit te proberen.
een mooie README is ook een goede manier om mensen te helpen bij het project. Een project met mooie README en screenshots zal de aandacht van gebruikers beter te krijgen, omdat het een directe manier om uit te leggen waarom dit project belangrijk is, en waarom mensen moeten gebruiken en bijdragen aan het project. Goede README moet ook voldoende details bevatten om een nieuwe gebruiker aan de slag te helpen, bijv., hoe te compileren, hoe te installeren en hoe te beginnen met integreren.
Ok. Genoeg gepraat. Laat me dan zien hoe je een goede README schrijft.
nu je het ermee eens bent dat README belangrijk is, zal ik je vertellen hoe je er een moet schrijven. Het is niet zo moeilijk. Je moet het bij een paar punten houden. Hier zijn enkele van de punten die u in gedachten moet houden tijdens het schrijven van een README.
opmaak van README?,
nu je jezelf hebt geleerd hoe en wat te schrijven in een README, laten we het eens hebben over de styling van README aka formatting.
formatteren is een essentieel onderdeel van README. U kunt leren over het formatteren van uw README van hier en hier.
houd uiteindelijk in gedachten –
u hoeft geen volledige Readme-gestuurde ontwikkeling te doen, u hoeft niet al die bullet points op te nemen , u hoeft geen bepaald proces te volgen. Maar het schrijven van een goede README zal zeker verbeteren van uw documentatie vaardigheden die je een betere ontwikkelaar zal maken.,
Leave a Reply