Merge pull request #8 from Lend-it/devel

Primeira release do projeto -  v0.3.0

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,43 @@
+---
+name: Bug report
+about: Bug encontrado na aplicação
+title: "[BUG] - "
+labels: bug
+assignees: ''
+
+---
+
+## Descrição
+**Descreva o bug**
+Uma descrição clara e concisa do que é o bug.
+
+## Como reproduzir:
+**Para reproduzir**
+Passos para reproduzir o comportamento:
+1. Vá para '...'
+2. Clique em '....'
+3. Desça a tela até '....'
+4. Veja o erro
+
+## Comportamento esperado:
+**Comportamento esperado**
+Uma descrição clara e concisa do que era esperado acontecer.
+
+## Screenshots:
+**Screenshots ou capturas de tela**
+Se aplicável, adicione screenshots para ajudar a explicar seu problema.
+
+## Especificações:
+**Desktop (por favor, informe qual é o navegador, browser utilizado ao encontrar o bug):**
+ - OS: [ex.: iOS]
+ - Browser [ex.: chrome, safari]
+ - Version [ex.: 22]
+
+**Smartphone (por favor, informe qual é o navegador, browser utilizado ao encontrar o bug):**
+ - Device: [ex.: iPhone6]
+ - OS: [ex.: iOS8.1]
+ - Browser [ex.: stock browser, safari]
+ - Version [ex.: 22]
+
+**Informações adicionais**
+Adicione outras informações sobre o problema aqui, se necessário.

.github/ISSUE_TEMPLATE/issue-template.md

@@ -0,0 +1,33 @@
+---
+name: Issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Descrição da Issue
+[Descrever de forma sucinta a issue, colocando quaisquer informações necessárias para a realização da mesma.]
+
+## Tasks:
+- [ ] Task 1
+- [ ] Task 2
+- [ ] Task 3
+
+## Critérios de Aceitação:
+- [ ] Critério 1
+- [ ] Critério 2
+- [ ] Critério 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.
+
+## Milestone
+A issue deve ser atribuída ao Milestone (sprint) correspondente previsto para sua execução.
+
+## Estimate
+Deve se adicionar à issue a sua estimativa de dificuldade (pontuação).

.github/ISSUE_TEMPLATE/user-story-template.md

@@ -0,0 +1,31 @@
+---
+name: User Story Template
+about: Template para user stories
+title: "[US] - "
+labels: ''
+assignees: ''
+
+---
+
+## Título da issue
+
+### Descrição:
+
+### Tarefas:
+
+- [ ] Tarefa 1;
+- [ ] Tarefa 2;
+- [ ] Tarefa 3;
+
+### Critérios de aceitação:
+
+- Paulo vinícius deverá conseguir ;
+- Paulo vinícius não deverá conseguir ;
+- CI estar passando ;
+- Respeitar todas as orientações acima.
+
+### Observações: (caso não tenha, delete essa parte)
+
+- 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,34 @@
+# Solve *Título da issue*
+ex (apagar):
+* Solve #80 Criação LendCard 
+* Solve #86 Criação CategoryChip
+
+
+## Issues
+
+* [Numero da issue] - titulo da issue
+
+ex (apagar):
+* [US06] - Eu, como usuário, gostaria de acessar ....
+
+## Descrição
+
+Breve descrição do que foi feito
+
+## Tipos de mudança
+
+Quais mudanças seu código introduz ao projeto?
+
+- [ ] Bugfix 
+- [ ] Criação/Evolução de funcionalidade  
+- [ ] Atualização de Documentação 
+
+## Checklist
+- [ ] Lint e testes passaram localmente com minhas mudanças
+- [ ] Eu adicionei testes que provam que minha correção é eficaz ou que minha feature funciona
+- [ ] Adicionei informações necessárias na documentação (se precisar)
+
+
+## Observações adicionais
+
+Caso tenha, adicionar observações do pr. 

.github/workflows/sonar.yml

@@ -2,7 +2,8 @@ name: SonarCloud analysis
 on:
   push:
     branches:
-      - master
+      - main
+      - devel
   pull_request:
     types: [opened, synchronize, reopened]
 jobs:
@@ -17,4 +18,4 @@ jobs:
         uses: SonarSource/sonarcloud-github-action@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

CODE_OF_CONDUCT.md

@@ -0,0 +1,94 @@
+# Citizen Code of Conduct
+
+## 1. Purpose
+
+A primary goal of Eps 2020 2 G1 is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
+
+We invite all those who participate in Eps 2020 2 G1 to help us create safe and positive experiences for everyone.
+
+## 2. Open [Source/Culture/Tech] Citizenship
+
+A supplemental goal of this Code of Conduct is to increase open [source/culture/tech] citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
+
+Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
+
+If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
+
+## 3. Expected Behavior
+
+The following behaviors are expected and requested of all community members:
+
+ * Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+ * Exercise consideration and respect in your speech and actions.
+ * Attempt collaboration before conflict.
+ * Refrain from demeaning, discriminatory, or harassing behavior and speech.
+ * Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+ * Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+
+## 4. Unacceptable Behavior
+
+The following behaviors are considered harassment and are unacceptable within our community:
+
+ * Violence, threats of violence or violent language directed against another person.
+ * Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
+ * Posting or displaying sexually explicit or violent material.
+ * Posting or threatening to post other people's personally identifying information ("doxing").
+ * Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+ * Inappropriate photography or recording.
+ * Inappropriate physical contact. You should have someone's consent before touching them.
+ * Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
+ * Deliberate intimidation, stalking or following (online or in person).
+ * Advocating for, or encouraging, any of the above behavior.
+ * Sustained disruption of community events, including talks and presentations.
+
+## 5. Weapons Policy
+
+No weapons will be allowed at Eps 2020 2 G1 events, community spaces, or in other spaces covered by the scope of this Code of Conduct. Weapons include but are not limited to guns, explosives (including fireworks), and large knives such as those used for hunting or display, as well as any other item used for the purpose of causing injury or harm to others. Anyone seen in possession of one of these items will be asked to leave immediately, and will only be allowed to return without the weapon. Community members are further expected to comply with all state and local laws on this matter.
+
+## 6. Consequences of Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
+
+## 7. Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. .
+
+
+
+Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
+
+## 8. Addressing Grievances
+
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify fga-eps-mds with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies. 
+
+
+
+## 9. Scope
+
+We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.
+
+This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
+
+## 10. Contact info
+
+
+
+## 11. License and attribution
+
+The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). 
+
+Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
+
+_Revision 2.3. Posted 6 March 2017._
+
+_Revision 2.2. Posted 4 February 2016._
+
+_Revision 2.1. Posted 23 June 2014._
+
+_Revision 2.0, adopted by the [Stumptown Syndicate](http://stumptownsyndicate.org) board on 10 January 2013. Posted 17 March 2013._

CONTRIBUTING.md

@@ -0,0 +1,76 @@
+## Como contribuir?
+Agradecemos pelo interesse em contribuir com o projeto! Para isso, basta seguir os passos abaixo:
+* Fazer o _fork_ do repositório, caso seja um colaborador externo.
+* Criar _issues_, em conformidade com o nosso template.
+* Criar uma ou mais _branches_ para trabalhar nas _issues_ levantadas, de acordo com nossa [política de branches](#política-de-branches).
+* Seguir nossa [política de commits](#política-de-commits) durante o desenvolvimento.
+* Ao final, submeter um _pull request_, também de acordo com nosso template.
+Simples assim!
+
+## Política de _branches_
+Segue-se o fluxo de trabalho descrito pelo [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), representado pelo diagrama abaixo:
+
+
+Dessa forma, existem as seguintes categorias de _branches_:
+
+### *_main_*
+_Branch_ de produção, com a versão estável mais atual do projeto. Bloqueada para commits e pushs, pode ser interagida apenas através de _pull requests_ provenientes da [_devel_](#devel), [_hotfix branches_](#hotfix-branches) ou [_release branches_](#release-branches).
+
+### *_devel_*
+_Branch de desenvolvimento_, agrupa o trabalho de outras _branches_ com o objetivo de se criar uma versão de _release_ para ser submetida à master. Também é bloqueada para commits e pushs, devendo ser modficada através de _pull requests_ provenientes das [_feature branches_](#feature-branches).
+
+### *_Feature Branches_*
+_Branches_ criadas a partir da _devel_, para o desenvolvimento de uma funcionalidade específica. Idealmente, uma _feature branch_ deve ser referente à uma issue cadastrada no repositório, para melhor acompanhamento e rastreamento do projeto. Ao final do desenvolvimento, deve-se submeter um _pull request_ visando a _devel_. Se as modificações forem aceitas com sucesso, a _branch_ deve ser apagada.
+  #### *Nomenclatura*
+  _Feature Branches_ devem seguir o padrão `x_nome_da_issue`, com x sendo o número da _issue_ correspondente no repositório.
+
+### *_Hotfix Branches_*
+_Branches_ criadas a partir da _master_, para a correção rápida de bugs em produção. Ao final, as atualizações submetidas devem ser integradas tanto à _master_ quanto à _devel_.
+  #### *Nomenclatura*
+  _Hotfix Branches_ devem seguir o padrão `hotfix_x_nome_da_issue`, com x sendo o número da _issue_ que identifica o bug a ser corrigido.
+
+### *_Release Branches_* 
+_Branches_ criadas a partir da _devel_, servem para a preparação de uma _release_ do projeto. Deve conter tarefas apenas relacionadas a essa _release_, como correção de bugs ou refino de alguma funcionalidade já implementada. Funcionalidades novas **não** devem ser desenvolvidas nessa _branch_. Com a _release_ preparada, deve-se integrar a branch à master.
+  #### *Nomenclatura*
+  _Release Branches_ devem seguir o padrão `release/numero_de_versao`, identificando a versão do produto que será entregue naquela _release_.
+
+### Mantendo _branches_ atualizadas
+Para um fluxo de trabalho sem grandes inconvenientes, recomenda-se manter as _branches_ pessoais de desenvolvimento (features, hotfixes) sempre atualizadas. Antes de se submeter um _pull request_, deve se garantir que a _branch_ possui todas as alterações mais recentes de sua _branch_ de origem. Para isso, deve se utilizar os seguintes comandos:
+```
+git checkout branch_de_trabalho
+
+git pull branch_de_origem # devel para features, master para hotfixes
+
+git push origin branch_de_trabalho
+```
+
+
+## Política de commits
+Devem seguir o modelo <type>: <description> do [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
+
+Por exemplo:
+
+``` 
+  git commit -m "docs: correct spelling of CHANGELOG"
+```
+
+Ao invés de:
+``` 
+  git commit -m "Adding API routing for User service."
+```
+
+### Commits em pares
+Ao se desenvolver funcionalidades utilizando a técnica de _pair programming_, deve se atribuir autoria a ambos os colaboradores. Para isso, deve se utilizar a tag _co-authored-by_ do Github, através dos seguintes passos:
+* Após adicionar todos os arquivos modificados, executar o commit sem flags adicionais:
+```
+git commit
+```
+* Isso abrirá o editor de texto padrão configurado para o Git. Digite a mensagem de commit, e após **duas** linhas em branco, adicione a co-autoria. Exemplo:
+```
+feat: add repo policies
+
+
+Co-authored-by: Nome Sobrenome <[email protected]>
+```
+
+Dessa forma o commit será contabilizado pelo Github como sendo realizado pelos dois contribuidores, gerando um registro mais detalhado de participação.

Dockerfile-dev

@@ -4,7 +4,7 @@ FROM python:3.8.0-alpine
 # new
 # install dependencies
 RUN apk update && \
-    apk add --virtual build-deps gcc python-dev musl-dev && \
+    apk add --virtual build-deps gcc g++ python-dev musl-dev && \
     apk add postgresql-dev && \
     apk add netcat-openbsd
 

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

@@ -15,4 +15,16 @@ test:
 	sudo docker-compose -f docker-compose.dev.yml run request python manage.py test
 
 lint:
-	sudo docker-compose -f docker-compose.dev.yml run request black .
+	sudo docker-compose -f docker-compose.dev.yml run request black .
+
+check-db:
+	sudo docker-compose -f docker-compose.dev.yml exec db psql -U postgres
+
+down:
+	sudo docker-compose -f docker-compose.dev.yml down
+
+recreate-db:
+	sudo docker-compose -f docker-compose.dev.yml run request python manage.py recreate-db
+
+cov:
+	sudo docker-compose -f docker-compose.dev.yml run request python manage.py cov

Procfile

@@ -0,0 +1 @@
+web: gunicorn manage:'create_app()'