Merge pull request #7 from fga-eps-mds/dev

Primeira Release - v1.0

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,53 @@
+# Código de conduta
+
+## Propósito
+
+O projeto é mantido por estudantes durante a execução das disciplinas
+de Engenharia de Produto de Software e Métodos de Desenvolvimento de Software
+da Universidade de Brasília.
+Sendo assim, frisamos a importância de promover um ambiente aberto e acolhedor,
+nós mantenedores e contribuidores nos comprometemos a fazer participação em nosso
+projeto e nossa comunidade provendo uma experiência livre de assédio para todos.
+
+## Nossas Responsabilidades
+
+Os mantenedores do projeto são responsáveis por esclarecer os padrões de comportamento 
+aceitável e devem tomar as medidas corretivas adequadas e justas em resposta a quaisquer 
+instâncias de comportamento inaceitável.
+
+Os mantenedores do projeto têm o direito e a responsabilidade de remover, e
+editar ou rejeitar comentários, commits, códigos, edições de wiki, 
+questões e outras contribuições que não estejam alinhadas a este Código de Conduta, 
+ou banir temporária ou permanentemente qualquer contribuidor por outros comportamentos 
+que eles consideram inadequados, ameaçadores, ofensivos ou prejudiciais.
+
+## Exemplos de comportamento que contribui para a criação de um ambiente positivo incluem:
+
+* Uso de linguagem acolhedora e inclusiva
+* Respeito aos diferentes pontos de vista
+* Aceitar críticas construtivas
+* Demonstrar empatia com os membros da comunidade
+
+## Exemplos de comportamento inaceitável por parte dos participantes incluem:
+
+* Uso de conotações sexuais
+* Comentários depreciativos que ataquem pessoas ou grupos
+* Assédio público ou privado
+* Publicação de conteúdo privado de terceiro sem prévia autorização
+* Outras condutas consideradas inapropriadas em um ambiente profissional
+
+## Escopo
+
+Este Código de Conduta se aplica tanto aos espaços do projeto quanto aos espaços públicos
+quando um indivíduo está representando o projeto ou sua comunidade. 
+Exemplos de representação de um projeto ou comunidade incluem o uso de um endereço de e-mail
+oficial do projeto, postagem por meio de uma conta oficial de mídia social ou atuação como 
+representante indicado em um evento.
+
+## Atribuição
+
+Esse código de conduta é uma adaptação de [Contributor Covenant][homepage], version 1.4,
+disponível em [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Guia de Contribuição
+
+Antes de realizar uma contribuição, conheça um pouco sobre o objetivo do projeto e também sobre o povo Kokama na nossa [documentação](https://fga-eps-mds.github.io/2020.2-Projeto-Kokama-Wiki/).
+
+## Como contribuir?
+
+Contribuições ao projeto são muito bem-vindas. Para manter um projeto bem organizado, ao contribuir observe as políticas abaixo:
+
+- Caso seja um contribuidor externo, faça um _fork_ do repositório e submeta as modificações através de _pull request_;
+- [Políticas de _issues_](CONTRIBUTING.md#política-de-issues);
+- [Política de _branchs_](CONTRIBUTING.md#política-de-branches);
+- [Política de _commits_](CONTRIBUTING.md#política-de-commits);
+- [Política de _merges_ e _pull request_](CONTRIBUTING.md#política-de-merges-e-pull-requests).
+
+### Política de Issues
+
+Para criação de issue, um [template de issue](https://github.com/fga-eps-mds/2020.2-Projeto-Kokama-Wiki/issues/new/choose) deve ser seguido.
+
+Caso encontre um bug ou tenha alguma sugestão de melhoria ao projeto, siga os passos abaixo:
+
+1. Verifique se já existe a [issue no repositório](https://github.com/fga-eps-mds/2020.2-Projeto-Kokama-Wiki/issues);
+2. Caso não exista nenhuma issue relacionada, [crie uma issue](https://github.com/fga-eps-mds/2020.2-Projeto-Kokama-Wiki/issues/new/choose);
+   1. Escolha o template de issue;
+   2. Preencha a issue de acordo com a orientação do template;
+   3. Defina as labels que são pertinentes ao problema ou sugestão;
+   4. Se aplicável, defina os responsáveis pela issue, o milestone e o projeto.
+3. Retire dúvidas através da issue.
+
+### Gitflow
+
+Para contribuir com o projeto, observe as políticas adotadas em relação a padronização e organização de código e documentação.
+
+#### Documentação
+
+Regras:
+
+1. Novas _branchs_ devem ser criadas a partir da _main_;
+2. Depois de fazer modificações na _branch_, submete-a por _pull request_ para integrar a _branch_ principal (_main_);
+3. Após aprovado ou recusado o _pull request_, apague a _branch_.
+
+#### Código
+
+1. Novas _branchs_ devem ser criadas a partir da _dev_;
+2. Depois de fazer modificações na _branch_, submete-a por _pull request_ para integrar a _branch_ secundária (_dev_);
+3. Após aprovado ou recusado o _pull request_, apague a _branch_.
+
+### Política de _Branches_
+
+#### _main_
+
+_main_ é a _branch_ de produção, onde se encontra a versão que estará disponível para utilização no mercado.
+
+#### _dev_
+
+_dev_ é a _branch_ de homologação, onde se encontra a versão mais atualizada do projeto.
+
+#### Nome das _Branches_
+
+Crie a _branch_ com a seguinte estrutura:
+
+```bash
+[número-da-issue]-<nome-significativo-da-branch-separada-por-hífens-com-letras-minusculas-sem-acento>
+```
+
+### Política de Commits
+
+Os commits deverão ser feitos em inglês iniciando com um verbo no presente simples, como, por exemplo: "Create a new API entrypoint".
+
+Para commits individuais, use: `git commit -m "Mensagem"`.
+Para commits em pares, digite `git commit` e atribua os _co-authoreds_ na mensagem:
+
+```bash
+Mensagem do commit
+
+
+Co-authored-by: Nome e sobrenome do parceiro(a) <[email protected]>
+```
+
+- Observação: quebrar duas linhas após a mensagme do commit.
+
+#### Título dos _Commits_
+
+Commits devem seguir os seguitnes modelos:
+
+- Commit de correção de _bugs_ ou falhas na _main_: `[HOTFIX] Mensagem`;
+- Commits de correção de _bugs_ ou falhas gerais: `[FIX] Mensagem`;
+- Os demais commits devem seguir o modelo: `Mensagem`.
+
+### Política de _Merges_ e _Pull Requests_
+
+#### _Pull Requests_
+
+Pull requests serão realizados para controle de estabilidade das _branches_:
+
+- _main_;
+- _dev_.
+
+Quando disponível uma nova _release_ ou funcionalidade, esta será integrada através de _pull request_ na _branch main_.
+
+Caso um _pull request_ já estava aberto e atualmente está em progresso, o título deve seguir o padrão `[WIP] Título`.
+
+Durante a criação de um _pull request_, deve-se observar o [template definido no repositório](https://github.com/fga-eps-mds/2020.2-Projeto-Kokama-Wiki/compare).
+
+##### _Code Review_
+
+Na revisão de código de _pull request_, observe os pontos abaixo:
+
+- O _pull request_ deve ser aceito por pelo menos um membro da equipe;
+- O revisor deve clonar a _branch_ do _pull request_ e verificar se as modificações de código ou documentação são coerente;
+- Em caso de aceitação do _pull request_, deve-se fazer a aprovação e realizar o merge;
+- Caso o _pull request_ esteja faltando algum requisito, deve-se informar ao contribuidor as mudanças necessárias;
+- Caso o _pull request_ não faça sentido, já tenha sido resolvido ou seja duplicado, deve ser fechado e feito um comentário a respeito.

.github/ISSUE_TEMPLATE/template-de-bug.md

@@ -0,0 +1,35 @@
+---
+name: Template de bug
+about: Template para criação de issues sobre bugs
+title: "[BUG] "
+labels: ''
+assignees: ''
+
+---
+
+**Descrição do bug**
+Uma descrição clara e concisa sobre do que o bug se trata.
+
+**Passos para reproduzir o bug**
+1. Vá para '...';
+2. Clique em '....';
+3. Clique em '....';
+4. Clique em '....';
+5. Veja o erro.
+
+**Comportamento esperando**
+Uma descrição clara e concisa sobre o que era esperado que acontecesse.
+
+**Screenshots**
+Se aplicado, adicionar imagens que ajudem a explicar o problema.
+
+**Ambiente**
+<!-- adicionar versão quando possível, colocar somente os que se aplicam no caso -->
+- SO: 
+- Navegador: 
+- Docker:
+- Docker-compose: 
+- Outro: escreva o nome de outros caso necessário
+
+**Contexto adicional**
+Qualquer outro contexto sobre o problema deve ser escrito aqui

.github/ISSUE_TEMPLATE/template-gen-rico-de-issues.md

@@ -0,0 +1,27 @@
+---
+name: Template genérico de issues
+about: Template para assuntos diversos como documentação e configuração de ferramentas
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Descrição
+
+<!-- Descrever de forma sucinta os diversos aspectos da issue: motivação e objetivo  -->
+<!-- Exemplo: Com o objetivo de <motivação>, essa issue busca <objetivo> -->
+
+## Tarefas
+
+<!-- Enumerar as tarefas necessárias para concluir a issue -->
+<!-- - [ ] Tarefa 1. -->
+
+## Critérios de Aceitação
+
+<!-- Enumerar os critérios de aceitação dessa issue -->
+<!-- - Exemplo 1. -->
+
+<!-- ## Observações -->
+
+<!-- Informações adicionais que ajudem no desenvolvimento da issue. -->

.github/ISSUE_TEMPLATE/template-novas-funcionalidades.md

@@ -0,0 +1,33 @@
+---
+name: Template de história de usuário (US) ou história técnica de usuário (TS)
+about: Template para criação de história de usuário (US) para novas funcionalidades
+  ou pendência técnica de história de usuário (TS)
+title: "[USXX/TSXX] Título da US/TS"
+labels: ''
+assignees: ''
+
+---
+
+## Descrição
+
+Eu, como <persona>, gostaria de <realizar algo> para <alcançar um objetivo>.
+
+## Tarefas
+
+<!-- Enumerar as tarefas necessárias para concluir a issue -->
+<!-- - [ ] Tarefa 1. -->
+
+## Critérios de Aceitação [?](http://www.metodoagil.com/historias-de-usuario/)
+
+<!-- Enumerar os critérios de aceitação dessa issue -->
+<!-- - Exemplo 1. -->
+
+<!-- ## Observações -->
+
+<!-- Informações adicionais que ajudem no desenvolvimento da issue. -->
+
+<!-- ## Lembretes -->
+
+<!-- - A issue deve ser pontuada; -->
+<!-- - A issue deve ser delegada a alguém; -->
+<!-- - A issue deve ter labels. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+## Descrição 
+
+<!-- Descrição coesa e concisa sobre o contéudo do pull request. -->
+
+<!-- **Resolve a issue [#00]().** -->
+
+## Tarefas realizadas
+
+<!-- Enumerar as tarefas desenvolvidas nesse pull request -->
+<!-- - [ ] Tarefa 1. -->
+
+<!-- ## Evidências de conclusão das tarefas -->
+
+<!-- Caso necessário, adicionar documentos correspondentes à funcionalidade implementada.  -->
+<!-- Por exemplo: Print de telas, protótipos de alta ou baixa fidelidade e etc. -->
+
+<!-- ## Observações -->
+
+<!-- Informações adicionais como explicar peculiaridades da implementação, compartilhar informações relevantes ao pull request, informar dependências decorrentes da implementação (exemplo: arquivos de configuração) etc. -->
+
+<!-- ## Lembretes -->
+
+<!-- - O pull request deve ter revisores; -->
+<!-- - O pull request deve ser atribuído aos seus desenvolvedores; -->
+<!-- - O pull request deve ter um milestone; -->
+<!-- - O pull request deve estar atrelado a uma issue. -->

.gitignore

@@ -1 +1,4 @@
-translate/__pycache__
+__pycache__/
+migrations/
+.vscode
+**.env

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 EPS/MDS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -1,5 +1,5 @@
 default:
-	docker-compose up
+	docker-compose up --build
 
 enter:
 	docker-compose exec web bash

README.md

@@ -1 +1,8 @@
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2020.2-Projeto-Kokama-Traducao&metric=alert_status)](https://sonarcloud.io/dashboard?id=fga-eps-mds_2020.2-Projeto-Kokama-Traducao)
+
 # 2020.2-Projeto-Kokama-Traducao
+
+## Execução
+
+* Para executar a aplicação basta usar a chamada `make`
+* Para entrar no container em execução, use `make enter`

administration/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

administration/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AdministrationConfig(AppConfig):
+    name = 'administration'

administration/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.