We're a place where coders share, stay up-to-date and grow their careers.
the First thing a README IMO is a clear sentence (TL;DR version) what is the repo about.
After that a table of content for easy navigation.
Sections can be :
for CONTRIBUTION.md you get some inspiration from famous repos, it's basically a spec document on how to run tests, add PR, code style and so on
the First thing a README IMO is a clear sentence (TL;DR version) what is the repo about.
After that a table of content for easy navigation.
Sections can be :
for CONTRIBUTION.md you get some inspiration from famous repos, it's basically a spec document on how to run tests, add PR, code style and so on