Hei, nybegynnere,
Gratulerer på å gjøre din vei til åpen kildekode. Det er et stort fellesskap.
Det er litt forvirrende i starten. Hvordan til å bidra, og der hvor å bidra med, problemer, bugs, PR, PR, PR!
ikke bekymre deg, som du får deg engasjert i open source vil du lære det hele tatt.
Men i dag ønsker jeg å gi deg noen råd som jeg aldri fikk da jeg startet min open source reise.
jeg startet å bidra til åpen kildekode og sette all min lille side prosjekter på GitHub for en stund siden., Tilbake da jeg ikke vet om den VIKTIG del. Tiden gikk og jeg begynte å følge noen kickass utviklere. Ingen tvil om at de alle hadde fantastiske prosjekter, men den mest vanlige ting var i alle sine prosjekter hadde awesome VIKTIG-og det er hvordan jeg kom til å vite om betydningen av en god README.
STOPP!! Jeg er ikke interessert i å lese om dine open source reise. Bare fortell meg om hvordan skrive en god README.
Kult. Så her du går —
Før du begynner å sette din awesome prosjekter på GitHub, jeg vil du skal gå og lese om Readme-Drevet Utvikling først.,
Hvorfor skal jeg bry meg om en VIKTIG?
Open source-miljøet vokser raskt. Utviklere slipper ny, åpen kildekode-prosjekter på GitHub hver dag. Som et resultat, det blir mer og mer vanskelig å få ditt eget prosjekt for å skille seg ut fra hav av open-source programvare. Men du kan gjøre noen ting for å øke sjansene for å ta tak i andre developer ‘ s oppmerksomhet. En effektiv og enkel teknikk er å sette opp en pen og nyttig README-filen.
Din README skal være så god som prosjektet ditt., En stor README-filen bidrar prosjektet til å skille seg ut fra havet av åpen programvare på GitHub.
EN README-er som ansiktet av prosjektet. Det er den første filen som en person bør lese når den møter en kilde treet, og det burde være skrevet som en veldig kort og gir svært grunnleggende introduksjon til programvaren.
Et prosjekt uten README er ikke så nyttig. La oss ta en titt på dette prosjektet, for eksempel.
Ingen README, ingen beskrivelse, ingen ingenting. Du vil ikke få noen som helst anelse om hva denne fyren bygget, uansett hvor fantastisk det er.,
la oss Nå ta en titt på dette prosjektet. Forfatteren har nevnt detaljerte og klare instruksjoner om prosjektet og dermed lettere for andre å bruke og prøve det ut.
En fin VIKTIG er en god måte å hjelpe folk å engasjere seg i prosjektet som godt. Et prosjekt med fin README-og skjermbilder vil få oppmerksomhet av brukerne bedre siden det er en direkte måte å forklare hvorfor dette prosjektet saker, og hvorfor folk skal bruke og bidra til prosjektet. God README skal også inneholde nok informasjon til å hjelpe nye brukere å komme i gang, f.eks., hvordan å lage, hvordan å installere, og hvordan du kan starte å integrere.
Ok. Nok snakk. Vis meg hvordan du skriver en god README da.
Nå som du er enig i at README-saker, jeg vil fortelle deg hvordan å skrive en. Det er ikke så vanskelig. Du trenger bare å feste med noen av punktene. Her er noen av punktene som du bør huske på mens du skriver en README fil.
Formatering av README?,
Nå som du har lært deg selv hvordan og hva du skal skrive i en README, la oss snakke litt om styling av README-aka formatering.
Formatering er en viktig del av README. Du kan lære om hvordan du formaterer VIKTIG fra her og her.
til slutt, husk —
Du trenger ikke å gå i full bar Readme-Drevet Utvikling, trenger du ikke å inkludere alle disse punktene , du trenger ikke å følge noen bestemt prosess. Men å skrive en god README vil definitivt forbedre din dokumentasjon ferdigheter som vil gjøre deg til en bedre utvikler.,
Leave a Reply