Hey begyndere,
Tillykke med at gøre din vej til open source. Det er et godt samfund.
det er lidt forvirrende i starten. Hvordan til at bidrage, hvor at bidrage, spørgsmål, bugs, PR, PR, PR!
bare rolig, da du bliver involveret i open source, lærer du det hele.
men i dag vil jeg gerne give dig alle nogle råd, som jeg aldrig modtog, da jeg startede min open source-rejse.
Jeg begyndte at bidrage til open source og sætte alle mine små sideprojekter på GitHub for et stykke tid siden., Dengang vidste jeg ikke om README-delen. Tiden gik, og jeg begyndte at følge nogle kickass udviklere. Uden tvivl havde de alle fantastiske projekter, men den mest almindelige ting var, alle deres projekter havde fantastisk README, og det var sådan, jeg kom til at vide om vigtigheden af en god README.
STOP!! Jeg er ikke interesseret i at læse om din open source rejse. Bare fortæl mig om, hvordan man skriver en god README.
Cool. Så her går du —
før du begynder at sætte dine fantastiske projekter på GitHub, vil jeg have dig til at gå og læse om Readme drevet udvikling først.,
hvorfor skal jeg bekymre mig om en README?
Open source-fællesskabet vokser hurtigt. Udviklere frigiver nye open source-projekter på GitHub hver dag. Som et resultat bliver det mere og mere vanskeligt at få dit eget projekt til at skille sig ud fra havet af open source-soft .are. Du kan dog gøre et par ting for at øge dine chancer for at gribe anden udviklers opmærksomhed. En effektiv og enkel teknik er at sætte op en pæn og hjælpsom README-fil.
din README skal være lige så god som dit projekt., En stor README-fil hjælper dit projekt til at skille sig ud fra havet af open source-soft .are på GitHub.
en README er som ansigtet på dit projekt. Det er den første fil en person bør læse, når de støder på en kilde træ, og det skal skrives som en meget kort og giver meget grundlæggende introduktion til soft .aren.
et projekt uden README er ikke så nyttigt. Lad os tage et kig på dette projekt, for eksempel.
ingen README, ingen beskrivelse, nej ingenting. Du vil ikke få nogen ID.om, hvad denne fyr bygget, uanset hvor fantastisk det er.,
lad os nu se på dette projekt. Forfatteren har nævnt detaljerede og klare instruktioner om projektet og dermed lettere for andre at bruge og prøve det.
en dejlig README er en god måde at hjælpe folk med at deltage i projektet også. Et projekt med flot README-og screenshots vil få den opmærksomhed af brugerne bedre, da det er en direkte måde at forklare, hvorfor dette projekt spørgsmål, og hvorfor folk skal bruge og bidrage til projektet. God README bør også indeholde nok detaljer til at hjælpe en ny bruger med at komme i gang, f. eks., hvordan man kompilerer, hvordan man installerer, og hvordan man begynder at integrere.
Ok. Nok snak. Vis mig, hvordan man skriver en god README derefter.nu, da du er enig i, at README betyder noget, fortæller jeg dig, hvordan du skriver en. Det er ikke så svært. Du skal bare holde fast i nogle punkttegn. Her er nogle af de punkter, du skal huske på, mens du skriver en README.
Formatering af README?,nu hvor du har lært dig selv, hvordan og hvad du skal skrive i en README, lad os tale lidt om stylingen af README aka formatering.formatering er en væsentlig del af README. Du kan lære om, hvordan du formaterer din README fra her og her.
I sidste ende, er Holde i sindet —
Du behøver ikke at gå fuld-bar Readme-Drevet Udvikling, behøver du ikke at inkludere alle dem, punktopstillinger , behøver du ikke at følge en bestemt proces. Men at skrive en god README vil helt sikkert forbedre dine dokumentationsevner, hvilket vil gøre dig til en bedre udvikler.,
Leave a Reply