Skip to content
Snippets Groups Projects
Commit ed5dc469 authored by Ângela Luiza Cunha Legey's avatar Ângela Luiza Cunha Legey
Browse files

Adiciona configuração inicial do repositório

parent 1f13e7d1
No related branches found
No related tags found
1 merge request!4Issue#14
......@@ -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*
......
......@@ -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*
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment