Commit a3785e56d1199f11ba8823067b1d131c3c27c56d
1 parent
2979495d
Exists in
master
adicionando politica de contribuição
Showing
1 changed file
with
36 additions
and
0 deletions
Show diff stats
| @@ -0,0 +1,36 @@ | @@ -0,0 +1,36 @@ | ||
| 1 | +# Guia de Contribuição - Como contribuir com o Protocolo Eletrônico? | ||
| 2 | +Gostou do nosso projeto e deseja contribuir de alguma forma? Comece por aqui! | ||
| 3 | + | ||
| 4 | +## Você achou algum *bug*? | ||
| 5 | +* **Verifique se ele já não foi reportado** procurando na seção de *[issues](https://softwarepublico.gov.br/gitlab/prototocolizacao/protocolizacao/issues)* do projeto. | ||
| 6 | + | ||
| 7 | +* Se você não encontrar nenhum *report* para o *bug* encontrado, [crie uma nova](https://softwarepublico.gov.br/gitlab/prototocolizacao/protocolizacao/issues). | ||
| 8 | +Fique atento para incluir um **título e uma descrição clara**, com a maior quantidade de **informações relevantes** possível. Preferencialmente, inclua um **trecho de código, anexos e uma execução passo a passo para a reprodução do problema**, informando o resultado esperado. | ||
| 9 | + | ||
| 10 | +## Você deseja adicionar alguma correção de bug ou uma nova funcionalidade? | ||
| 11 | +* **Verifique se já existe alguma issue relacionada**, procurando na seção de [issues](https://softwarepublico.gov.br/gitlab/prototocolizacao/protocolizacao/issues) do projeto. | ||
| 12 | + | ||
| 13 | +* **Caso não exista, [crie uma nova](https://softwarepublico.gov.br/gitlab/prototocolizacao/protocolizacao/issues)**. Certifique-se de **adicionar um título e descrição** clara do que foi realizado. | ||
| 14 | +* **As adições devem ser feitas através de *pull requests***. | ||
| 15 | + | ||
| 16 | +### Como contribuir através de *pull requests*? | ||
| 17 | +Para contribuir com o projeto é muito fácil, basta seguir os seguintes passos: | ||
| 18 | + | ||
| 19 | +* *Fork* do repositório | ||
| 20 | + * Crie um fork do repositório no seu ambiente | ||
| 21 | + | ||
| 22 | +* Criar **issues** | ||
| 23 | + * Crie uma issue relacionada com o que deseja adicionar no projeto. | ||
| 24 | + * Certifique-se de **adicionar um título e descrição** clara do que foi realizado. | ||
| 25 | + | ||
| 26 | +* Criar **branchs** | ||
| 27 | + * Crie uma branch com o mesmo nome da issue aberta. | ||
| 28 | + * Trabalhe na sua modificação | ||
| 29 | + | ||
| 30 | +* Submeter **Pull Request** | ||
| 31 | + * Crie um *pull request* com o mesmo nome da branch criada, para o branch master. | ||
| 32 | + | ||
| 33 | + | ||
| 34 | + | ||
| 35 | + | ||
| 36 | + |