Hej początkujący,
gratulujemy udania się na open source. To wspaniała społeczność.
to trochę mylące na początku. Jak wnosić wkład, gdzie wnosić wkład, problemy,błędy, PR, PR, PR!
nie martw się, ponieważ zaangażujesz się w open source, dowiesz się wszystkiego.
ale dzisiaj chciałbym dać wam wszystkim kilka rad, których nigdy nie otrzymałem, gdy zaczynałem moją podróż open source.
jakiś czas temu zacząłem tworzyć open source i umieszczać wszystkie moje małe projekty poboczne na Githubie., Wtedy nie wiedziałem o części README. Czas minął i zacząłem podążać za kilkoma zajebistymi programistami. Bez wątpienia wszyscy mieli niesamowite projekty, ale jedną z najczęstszych rzeczy było to, że wszystkie ich projekty miały niesamowite README i w ten sposób dowiedziałem się o znaczeniu dobrego README.
STOP!! Nie jestem zainteresowany czytaniem o Twojej podróży open source. Po prostu powiedz mi, jak napisać dobry README.
fajne. Więc proszę bardzo –
zanim zaczniesz umieszczać swoje niesamowite projekty na Githubie, chcę, żebyś najpierw przeczytał o Readme Driven Development.,
Dlaczego warto dbać o README?
społeczność Open source szybko rośnie. Deweloperzy publikują nowe projekty open-source na Githubie każdego dnia. W rezultacie, coraz trudniej jest uzyskać własny projekt, aby wyróżniać się z Morza oprogramowania open-source. Możesz jednak zrobić kilka rzeczy, aby zwiększyć swoje szanse na przyciągnięcie uwagi innych deweloperów. Jedną z skutecznych i prostych technik jest umieszczenie ładnego i pomocnego pliku README.
Twój README powinien być tak dobry jak Twój projekt., Świetny plik README pomaga Twojemu projektowi wyróżnić się na tle morza oprogramowania open-source na GitHub.
README jest jak twarz Twojego projektu. Jest to pierwszy plik, który osoba powinna przeczytać, gdy natknie się na drzewo źródłowe, i powinien być napisany jako bardzo krótki i dający bardzo podstawowe wprowadzenie do oprogramowania.
Projekt bez README nie jest tak przydatny. Spójrzmy na przykład na ten projekt.
No README, no description, no nothing. Nie masz pojęcia, co ten facet zbudował, bez względu na to, jak to jest niesamowite.,
teraz przyjrzyjmy się temu projektowi. Autor wspomniał szczegółowe i jasne instrukcje dotyczące projektu, a tym samym łatwiejsze do wykorzystania i wypróbowania przez innych.
miły README jest dobrym sposobem, aby pomóc ludziom zaangażować się w projekt, jak również. Projekt z ładnym README i zrzutami ekranu zwróci uwagę użytkowników lepiej, ponieważ jest to bezpośredni sposób na wyjaśnienie, dlaczego ten projekt ma znaczenie i dlaczego ludzie powinni korzystać i wnosić swój wkład w projekt. Dobry README powinien również zawierać wystarczająco dużo szczegółów, aby pomóc nowemu użytkownikowi zacząć, np., jak skompilować, jak zainstalować i jak rozpocząć integrację.
Ok. Dość gadania. Pokaż mi więc, jak napisać dobry README.
skoro się ZGADZASZ, ŻE README ma znaczenie, to powiem Ci, jak to napisać. To nie takie trudne. Musisz tylko trzymać się kilku punktów. Oto niektóre z punktów, o których należy pamiętać pisząc README.
formatowanie README?,
teraz, gdy nauczyłeś się jak i co pisać w README, porozmawiajmy trochę o stylizacji README aka formatowanie.
formatowanie jest istotną częścią README. Możesz dowiedzieć się, jak formatować README tutaj i tutaj.
na koniec pamiętaj —
nie musisz iść do pełnego rozwoju Readme Driven, nie musisz zawierać wszystkich tych punktów, nie musisz śledzić żadnego konkretnego procesu. Ale pisanie dobrego README na pewno poprawi twoje umiejętności dokumentacji, co uczyni cię lepszym programistą.,
Leave a Reply