diff --git a/cp_07.Rmd b/cp_07.Rmd index 3835f6e6aa0633fc29828bc753ce02cd0a873cfe..e27031e513cdb421b6dc38862b0ba357e36ef5a4 100644 --- a/cp_07.Rmd +++ b/cp_07.Rmd @@ -38,8 +38,29 @@ usuário pode ter um nÃvel de acesso diferente: **Guest**, **Reporter**, permissões</a> é possÃvel visualizar as habilidades concedidas para cada nÃvel. - - +Logo após criar um novo repositório, é recomendável que se crie um arquivo +`README.md`. Independente da forma como o repositório foi configurado, +é sempre fundamental que ele contenha o arquivo `README.md`. +Este arquivo é sempre o primeiro a ser mostrado na página inicial +de todo repositório. Por esse motivo, é importante que o `README.md` +contenha no mÃnimo: + +- Uma descrição geral do projeto; +- Os nomes dos autores do projeto; +- Instruções de instalação, no caso de softwares; +- A licença do projeto (especialmente para projetos públicos), ou uma +orientação sobre o uso do projeto (permissão, citação, ...). +Opcionalmente pode-se criar um arquivo *LICENSE* com a licença. +Esse arquivo ficará disponÃvel também em uma aba na página inicial do +projeto. +- (**Opcional**): um guia de contribuição, se o projeto pretende que +colaboradores externos colaborem e precisam de algumas orientações básicas +sobre como colaborar. Criando um arquivo `CONTRIBUTING.md` com este guia, +ele será automaticamente colocado em uma aba na página inicial do projeto. +- (**Opcional**) um *changelog* para que sejam registradas as modificações +realizadas entre uma versão e outra (principalmente para softwares). +Criando esse arquivo com estas informações, ele aparecerá automaticamente +em uma aba na página inicial do projeto. - *Repositórios: nÃveis de acesso, adicionar colaboradores, configuração inicial do repositório* diff --git a/cp_07.md b/cp_07.md index ff6d7a5fba509e66355ebf3018826024c50544c8..f45dd6140b051cbf59a25d50c110b710353e8ceb 100644 --- a/cp_07.md +++ b/cp_07.md @@ -33,6 +33,29 @@ usuário pode ter um nÃvel de acesso diferente: **Guest**, **Reporter**, permissões</a> é possÃvel visualizar as habilidades concedidas para cada nÃvel. +Logo após criar um novo repositório, é recomendável que se crie um arquivo +`README.md`. Independente da forma como o repositório foi configurado, +é sempre fundamental que ele contenha o arquivo `README.md`. +Este arquivo é sempre o primeiro a ser mostrado na página inicial +de todo repositório. Por esse motivo, é importante que o `README.md` +contenha no mÃnimo: + +- Uma descrição geral do projeto; +- Os nomes dos autores do projeto; +- Instruções de instalação, no caso de softwares; +- A licença do projeto (especialmente para projetos públicos), ou uma +orientação sobre o uso do projeto (permissão, citação, ...). +Opcionalmente pode-se criar um arquivo *LICENSE* com a licença. +Esse arquivo ficará disponÃvel também em uma aba na página inicial do +projeto. +- (**Opcional**): um guia de contribuição, se o projeto pretende que +colaboradores externos colaborem e precisam de algumas orientações básicas +sobre como colaborar. Criando um arquivo `CONTRIBUTING.md` com este guia, +ele será automaticamente colocado em uma aba na página inicial do projeto. +- (**Opcional**) um *changelog* para que sejam registradas as modificações +realizadas entre uma versão e outra (principalmente para softwares). +Criando esse arquivo com estas informações, ele aparecerá automaticamente +em uma aba na página inicial do projeto. - *Repositórios: nÃveis de acesso, adicionar colaboradores, configuração inicial do repositório*