Adding opensource docs

.github/ISSUE_TEMPLATE/hist-ria-de-usu-rio.md

@@ -0,0 +1,26 @@
+---
+name: História de Usuário
+about: Descrição de uma história de usuário
+---
+
+**Descrição**
+Eu, como **_persona_**, gostaria de **_realizar algo_** para **_alcance um objetivo_**.
+
+**Critérios de Aceitação** [?](http://www.metodoagil.com/historias-de-usuario/)
+
+- Deverá ter o campo ...;
+- Deverá calcular/apresentar ...;
+- Funcionalidade testada;
+
+**Tarefas**
+
+- [ ] Não é um épico. [Leia](https://sitecampus.com.br/user-story-epico-e-tema-qual-diferenca/);
+- [ ] É testável;
+- [ ] É estimável pelo time de desenvolvimento;
+- [ ] Traz valor ao negócio;
+
+**Observações**
+
+- A issue deve ser pontuada;
+- A issue deve ser delegada a alguém;
+- A issue deve ter labels;

.github/ISSUE_TEMPLATE/issue-template.md

@@ -0,0 +1,35 @@
+---
+name: Issue Template
+about: Template destinado para facilitar a criação de issues
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Nome da Issue
+
+[Descrição simples da tarefa a ser realizada.]
+
+## Descrição da Issue
+
+[Descrever issue brevemente, colocando informações necessárias para a realização da mesma.]
+
+### Tasks:
+
+- [ ] Task 1
+- [ ] Task 2
+- [ ] Task 3
+
+### Critérios de aceitação
+
+- [ ] 1
+- [ ] 2
+- [ ] 3
+
+## Assignees
+
+A issue deve ser atribuída a pelo menos um colaborador do projeto.
+
+## Labels
+
+A issue deve ser marcada com uma ou mais tags adequadas, para fins de rastreamento do projeto.

CODE_OF_CONDUCT.md

@@ -0,0 +1,53 @@
+# Código de Conduta para Colaboradores
+
+## Histórico de Revisão
+
+| Autor                                              | Descrição            | Data       | Versão |
+| -------------------------------------------------- | -------------------- | ---------- | ------ |
+| [Matheus Blanco](https://github.com/MatheusBlanco) | Criação do Documento | 10/02/2021 | 1.0    |
+
+## Introdução
+
+Este documento foi criado com o objetivo de servir como um guia de conduta para prováveis contribuidores deste projeto. O mesmo deve ser seguido para que se possa promover um ambiente seguro e produtivo de construção, revisão e utilização do software definido neste projeto.
+
+## Nossa promessa
+
+Com o interesse de fomentar uma comunidade aberta e acolhedora, nós, como colaboradores e administradores deste projeto, comprometemo-nos a fazer a participação deste projeto uma experiência livre de assédio para todos, independentemente da aparência pessoal, deficiência, etnia, gênero, idade, identidade ou expressão de gênero, identidade ou orientação sexual, nacionalidade, nível de experiência, porte físico, raça ou religião.
+
+## Nossos padrões
+
+**Exemplos de comportamentos que contribuem a criar um ambiente positivo incluem:**
+
+- Usar linguagem acolhedora e inclusiva
+- Respeitar pontos de vista e experiências diferentes
+- Aceitar crítica construtiva com graça
+- Focar no que é melhor para a comunidade
+- Mostrar empatia com outros membros da comunidade
+
+**Exemplos de comportamentos inaceitáveis por parte dos participantes incluem:**
+
+- Uso de linguagem ou imagens sexuais e atenção ou avanço sexual indesejada
+- Comentários insultuosos e/ou depreciativos e ataques pessoais ou políticos (Trolling)
+- Assédio público ou privado
+- Publicar informação pessoal de outros sem permissão explícita, como, por exemplo, um endereço eletrônico ou residencial
+- Qualquer outra forma de conduta que pode ser razoavelmente considerada inapropriada num ambiente profissional
+
+## Nossas responsibilidades
+
+Os administradores do projeto são responsáveis por esclarecer os padrões de comportamento e deverão tomar ação corretiva apropriada e justa em resposta a qualquer instância de comportamento inaceitável.
+
+Os administradores do projeto têm o direito e a responsabilidade de remover, editar ou rejeitar comentários, commits, código, edições na wiki, erros ou outras formas de contribuição que não estejam de acordo com este Código de Conduta, bem como banir temporariamente ou permanentemente qualquer colaborador por qualquer outro comportamento que se considere impróprio, perigoso, ofensivo ou problemático.
+
+## Escopo
+
+Este Código de Conduta aplica-se dentro dos espaços do projeto ou qualquer espaço público onde alguém represente o mesmo ou a sua comunidade. Exemplos de representação do projeto ou comunidade incluem usar um endereço de email oficial do projeto, postar por uma conta de mídia social oficial, ou agir como um representante designado num evento online ou offline. A representação de um projeto pode ser ainda definida e esclarecida pelos administradores do projeto.
+
+## Aplicação
+
+Comportamento abusivo, de assédio ou de outros tipos pode ser comunicado contatando a equipe do projeto [INSIRA O ENDEREÇO DE EMAIL]. Todas as queixas serão revistas e investigadas e resultarão numa resposta necessária e apropriada à situação. A equipe é obrigada a manter a confidencialidade em relação ao elemento que reportou o incidente. Demais detalhes de políticas de aplicação podem ser postadas separadamente.
+
+Administradores do projeto que não sigam ou não mantenham o Código de Conduta em boa fé podem enfrentar repercussões temporárias ou permanentes determinadas por outros membros da liderança do projeto.
+
+## Atribuição
+
+Este Código de Conduta é adaptado do **Contributor Covenant**, versão 1.4, disponível em [https://www.contributor-covenant.org/pt-br/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/pt-br/version/1/4/code-of-conduct.html)

CONTRIBUTING.md

@@ -0,0 +1,95 @@
+# Contribuindo para o projeto 🎈
+
+Adoramos a contribuição de novas pessoas! Gostaríamos de transformar a contribuição desse projeto na mais fácil possível. E adoramos todos os tipos de contribuição, seja:
+
+- Reportando um _bug_;
+- Enviando correções de _bugs_;
+- Enviando propostas de correções visuais;
+- Propondo novas funcionalidades;
+
+Precisa tirar alguma dúvida ou precisa de alguma inspiração? Conheça a nossa [Documentação](https://fga-eps-mds.github.io/EPS-2020-2-G2/).
+
+# Como iniciar o seu processo de Contribuição? 🎉
+
+Para contribuir com o projeto você pode estar abrindo _issues_ de sugestões e reports de acordo com o nosso [template](https://github.com/fga-eps-mds/EPS-2020-2-G2/blob/main/.github/ISSUE_TEMPLATE/issue-template.md). Ou você pode estar contribuindo para o nosso código. Basta seguir os seguintes passos:
+
+- Abra uma _issue_ em nosso repositório, seguindo o nosso [template](https://github.com/fga-eps-mds/EPS-2020-2-G2/blob/main/.github/ISSUE_TEMPLATE/issue-template.md);
+  - Se você só quer resolver uma _issue_ já aberta no respositório, se marque na _issue_ e comente nela (Atenção: Certifique-se de que não existe um responsável por essa _issue_ antes);
+- Faça um _fork_ do nosso projeto, se você for um contribuidor externo;
+- Crie uma _branch_ a partir da develop, seguindo a nossa [política de _branch_](#politica-de-branch);
+- Crie um _Pull Request_ com o status de **_WIP_**, no repositório para certificarmos que você está trabalhando na _issue_;
+- Siga a [política de _commits_](#politica-de-commits) durante o desenvolvimento;
+- Ao final do desenvolvimento cetifique-se que seu código está funcionando e os testes passando;
+- Ao concluir o desenvolvimento, edite o seu _Pull Request_ removendo o status de **_WIP_** e seguindo o nosso [template padrão para _pull request_]().
+
+# Política de _Branches_ 🧠
+
+A nossa política de _Branches_ é baseada no [_Gitflow_](https://www.atlassian.com/br/git/tutorials/comparing-workflows/gitflow-workflow).
+
+Utilizamos dessa forma as seguintes _branches_:
+
+## **main**
+
+A _branch_ do nosso ambiente de Produção. Aqui é a _branch_ com o código mais estável do projeto. Todos os _commits_ diretos nessa _branch_ estão bloqueados.
+
+## **develop**
+
+A _branch_ do nosso ambiente de Homologação.Essa é a _branch_ de integração das novas funcionalidades. Toda nova funcionalidade deve ser desenvolvida a partir dessa _branch_.
+
+### **_Nomeclatura_**
+
+As _features_ _branches_ devem seguir o seguinte padrão de nome `id_nome_issue`.
+
+**Exemplo**: Na _issue_ **_Criar Guia de Contribuição do Projeto #2_**, você deverá nomear a branch da seguinte forma: `2_criar_guia_contribuicao`.
+
+As _hotfix_ _branches_ devem seguir o seguinte padrão de nome `hotfix_id_nome_issue`.
+
+**Exemplo**: Na _issue_ **_Corrigir Bug no Login #221_**, você deverá nomear a _branch_ da seguinte forma: `hotfix_221_corrigir_bug_login`.
+
+Já as _releases_ _branches_ devem seguir o seguinte padrão de nome
+`release/numero_de_versao`.
+
+### **_Branches_ Atualizadas**
+
+Sempre mantenha a sua _branch_ atualizada com a _branch_ de origem.
+Recomendamos a utilização do comando _rebase_ para isso.
+
+**Exemplo**:
+
+```
+> git pull --rebase origin branch_origem
+```
+
+# Política de _Commits_ ☄️
+
+Seguimos os seguintes padrões na nossa política de _commits_:
+
+- Realize o seu _commit_ em inglês.
+- Ele deve descrever de forma objetiva o que você fez.
+- Evite _commits_ desnecessários.
+- Evite coisas como "_This commit..._" ou "_I have..._"
+- Utilize as frases no imperativo.
+
+**Exemplo**:
+
+```
+> git commit -m "Create route to get report"
+```
+
+Caso você esteja em um _pair programming_ utilize o _co-authored-by_ para poder atribuir reconhecimento para o seu colega de trabalho.
+Basta seguir os seguintes comandos:
+
+```
+> git commit
+```
+
+Isso irá abrir o seu editor de texto padrão. A partir disso edite o conteúdo que estiver dentro para algo parecido com:
+
+```
+Create route to get report
+
+
+Co-authored-by: Kazuma Kiryu <[email protected]>
+```
+
+Dessa forma o _commit_ será atribuido para ambos desenvolvedores.