Executando verificação de segurança...
1
Carregando publicação patrocinada...
2

Cara a documentação em projetos do github temos o Readme, a parte de contribuição, a lincença ( MIT, licença apache, etc ) e você pode linkar outras paginas .md do seu projeto no Readme.

Então se você pensa em fazer um projeto open source por exemplo, a parte de Contribuição (que é um arquivo que vai ficar destacado ao lado do readme principal junto com a licensa), é importortante para explicar e detalhar como a pessoa pode ou não contribuir e como ela vai fazer isso.

A licença é importante para definir o "conteito legal" do seu projeto, se ele pode ser copiado ou modificado, etc.

E customizar o seu link de issue é um toque bacana para colocar no seu projeto!

PS: Tem esses outros 2 arquivos que são destacados CODE_OF_CONDUCT.md e SECURITY.md que cada um tem sua função sobre issues e codigos de conduta.

Normalmente o pessoal preenche mais só o readme.md mesmo, mas é bom saber identificar as outras ocasiões aonde deve ter os outros arquivos. Mas tudo depende da complexidade do seu projeto ou se for open, se ele for MUITO complexo é normal eles tirarem a documentação do github e jogar para um site a parte (exemplo: documentação de bibliotecas grandes como Electron)