Merge pull request #17 from ThiagoPanini/v0.1.0

Release v0.1.0 with a package refactor proposal

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,35 +1,35 @@
 ---
 name: Bug Report
-about: Pontuando erros e auxiliando em melhorias
+about: Declaring errors and suggesting improvements
 title: "[BUG]"
 labels: bug
 assignees: ThiagoPanini
 
 ---
 
-:writing_hand: **_Descrição do problema:_**
-TODO: forneça uma visão clara e direta do bug/problema e mencione qual a funcionalidade/módulo/método origem do problema. Adicionalmente, insira abaixo trechos de código que ajudem a identificar o bug/problema.
+:writing_hand: **_Problem description:_**
+ToDo: provide a clear vision of bug reported and point out the impact. Additionaly, insert block codes that help to identify and reproduce the bug.
 ```python
-# Espaço para trechos de código
+# Insert your code here
 ```
 ___
-:lady_beetle: **_Reprodução do problema:_**
-Para reproduzir o bug/problema, é necessário seguir as seguintes etapas:
-1. [ ] Importar o módulo ```package.module```
-2. [ ] Executar a função ```function```
-3. [ ] Estabelecer os parâmetros ```(param_a='a', param_b='b')```
-4. [ ] Visualizar o erro ```Exception e```
+:lady_beetle: **_Reproducing the problem:_**
+To reproduce the bug it's need the take the following steps (example):
+1. [ ] Import module ```package.module```
+2. [ ] Run the function ```function```
+3. [ ] Using paramteres ```(param_a='a', param_b='b')```
+4. [ ] Check the error ```Exception e```
 ___
-:gear: **_Comportamento adequado:_**
-TODO: descrever o que se esperava da funcionalidade.
+:gear: **_Expected behavior:_**
+ToDo: describe the feature expected behavior.
 ___
-:earth_americas: **_Informações adicionais de ambiente:_**
-TODO: forneça detalhes do ambiente utilizado que ajude no entendimento do bug/problema, como por exemplo, sistema operacional, versão da linguagem de programação, entre outros.
+:earth_americas: **_Additional information:_**
+ToDo: if applicable, provide some datails about the environment where the bug showed up. Informations like OS and language version are useful.
 ___
-:camera: **_Screenshots:_** [OPCIONAL]
-TODO: adicione capturas de tela com intuito de auxiliar no entendimento do bug/problema.
+:camera: **_Screenshots:_** [OPTIONAL]
+ToDo: if applicable, provide some screenshots that help to understand the bug.
 ___
-:speech_balloon: **_Possíveis soluções para o problema:_** [OPCIONAL]
-A resolução do bug/problema poderia ser implementada a partir de:
-- Solução A
-- Solução B
+:speech_balloon: **_Possible solutions:_** [OPTIONAL]
+Probably the the solution for this bug would be reached through:
+- Trying step A
+- Trying step B

.github/ISSUE_TEMPLATE/documentation.md

@@ -1,17 +1,14 @@
 ---
 name: Documentation
-about: Melhorias na documentação do código
+about: Docs improvement
 title: "[DOC]"
 labels: documentation
 assignees: ThiagoPanini
 
 ---
 
-:books: **_Funções, métodos ou objetos alvo:_**
-Elementos de código que necessitam de melhorias na documentação:
-- [ ] Função `function` presente em `pkg/module.py`
-- [ ] Método `method` da classe `class`
-- [ ] Módulo `pkg.module`
-___
-:pencil2: **_Detalhes adicionais:_**
-TODO: forneça uma descrição adicional da issue, templates que julgar adequados para melhorar a documentação do código existente e, se aplicável, indique problemas relacionados a documentação existente.
+:books: **_Target modules, classes or functions:_**
+Project componentes that needs a documentation improvement:
+- [ ] Function `function()` on `pkg/module.py`
+- [ ] Method `method()` from class `class`
+- [ ] Module `pkg.module`

.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,29 +1,29 @@
 ---
 name: Feature Request
-about: Sugestão de novas funcionalidades para o projeto
+about: Request of new features for project
 title: "[FEATURE]"
 labels: feature
 assignees: ThiagoPanini
 
 ---
 
-:rocket: **_Resumo da funcionalidade solicitada:_**
-TODO: forneça detalhes sobre como a nova funcionalidade poderia se comportar em meio ao projeto.
+:rocket: **_Feature needed:_**
+ToDo: provide details about the new feature requested and how would be its behavior along the project.
 ___
-:trophy: **_Resumo sobre benefícios da nova funcionalidade:_**
-Com a implementação dessa nova funcionalidade, os usuários poderiam: 
-* Obter...
-* Consumir...
-* Garantir que...
-* Aumentar...
+:trophy: **_Feature benefits:_**
+With this new features, user would:
+* Enhance...
+* Improve...
+* Ensure that...
+* Increase...
 * ...
 ___
-:books: **_Provável complexidade:_**
-A melhor opção que descreve a complexidade associada a esta funcionalidade é:
-- [Extrema/Alta/Média/Baixa] complexidade
+:books: **_Complexity:_**
+The best category that fits into the development of this new feature is:
+- [Extreme/High/Medium/Low] complexity
 ___
-:bulb: **_Ideias de implementação:_**
-Para implementação da funcionalidade, seria possível:
-- Consultar...
-- Consumir...
-- Aplicar...
+:bulb: **_Ideas on how to develop it:_**
+To develop this new feature, would be possible to:
+- Search for...
+- Apply...
+- Try...

.github/ISSUE_TEMPLATE/help-needed.md

@@ -1,19 +1,19 @@
 ---
 name: Help Needed
-about: Solicitação de auxílio pra realização de alguma operação
+about: Asking for help
 title: "[HELP]"
 labels: help wanted
 assignees: ''
 
 ---
 
-:red_circle: **_Descrição da ajuda necessária:_**
+:heavy_check_mark: **_Checklist to dobefore asking for help:_**
+Check with a "x" on topics already done for you before opening this issue:
+- [ ] I've already look at the project docs
+- [ ] I've already look at the possibility to have environment conflicts, like OS, python version, package version and others
+- [ ] I've already look at test scripts and demos available on repo and docs
+- [ ] I've already look at other similar issues
 
 ___
 
-:heavy_check_mark: **_Checklist de atuação preventiva:_**
-Marque um x nos blocos abaixo de acordo com a atuação preventiva realizada:
-- [ ] Verifiquei a documentação do projeto ou da funcionalidade alvo da dúvida
-- [ ] Verifiquei condições de ambiente, como sistema operacional, versão do Python, versão da lib, entre outras
-- [ ] Verifiquei scripts de testes e exemplos disponibilizados no repositório
-- [ ] Verifiquei possíveis outras issues com dúvidas ou pedidos semelhantes
+:red_circle: **_Help description:_**

.github/ISSUE_TEMPLATE/question.md

@@ -1,10 +1,9 @@
 ---
 name: Question
-about: Dúvidas e questões relacionadas ao projeto
+about: Project questions
 title: "[QUESTION]"
 labels: question
 assignees: ''
 
 ---
 
-

.github/codecov.yml

@@ -0,0 +1,14 @@
+ignore:
+  - setup.py
+coverage:
+  status:
+    patch:
+      default:
+        target: 0%
+        threshold: 5%
+        if_ci_failed: error
+    project:
+      default:
+        target: 0%
+        threshold: 5%
+        if_ci_failed: error

.github/configs/release-drafter.yml

@@ -0,0 +1,75 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+
+exclude-labels:
+  - github-bot 🤖
+
+categories:
+  - title: 🛠️ Breaking Changes
+    labels:
+      - breaking-change 🛠️
+
+  - title: 🚀 Features
+    labels:
+      - feature 🚀
+      - enhancement 🍀
+
+  - title: 💎 New Functions
+    labels:
+      - new-function 💎
+
+  - title: 🐞 Bug Fixes
+    labels:
+      - bug 🐞
+
+  - title: 💻 Application
+    labels:
+      - app 💻
+
+  - title: 🧱 Infrastructure
+    labels:
+      - infra 🧱
+
+  - title: 🛡️ Tests
+    labels:
+      - tests 🛡️
+
+  - title: ⚙️ Configuration and Maintenance
+      - config ⚙️
+
+  - title: 🖍️ Documentation
+    labels:
+      - doc 🖍️
+
+  - title: Other Changes
+    labels:
+      - "*"
+
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&'
+
+version-resolver:
+  major:
+    labels:
+      - breaking-change 🛠️
+  minor:
+    labels:
+      - feature 🚀
+      - enhancement 🍀
+  patch:
+    labels:
+      - app 💻
+      - infra 🧱
+      - tests 🛡️
+      - bug 🐞
+      - doc 🖍️
+      - observability 👁️‍🗨️
+      - config ⚙️
+      - new-function 💎
+
+  default: patch
+
+template: |
+  ## Changes
+
+  $CHANGES

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+:bookmark_tabs: **_PR details:_**
+ToDo: provide a detailed description for the Pull Request opened and ensure users can understand the main changes considered.
+___
+:link: **_Chained issues_**
+This PR eventually will close the following issues:
+- #.
+___
+:hammer: **_Tasks done:_**
+- Task A
+- Task B
+- ...
+___
+:heavy_check_mark: **_Checklist:_**
+- [ ] New code followed the best practices
+- [ ] New features were tested properly
+- [ ] There is no chance new features would compromise the project

.github/release.yml

@@ -0,0 +1,23 @@
+changelog:
+  exclude:
+    labels:
+      - doc 🖍️
+  categories:
+    - title: Breaking Changes 🛠️
+      labels:
+        - breaking-change 🛠️
+    - title: Features 🚀
+      labels:
+        - feature 🚀
+    - title: Bug Fixes 🐞
+      labels:
+        - bug 🐞
+    - title: Application 💻
+      labels:
+        - app 💻
+    - title: Infrastructure 🧱
+      labels:
+        - infra 🧱
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/ci-build-deploy.yml

@@ -0,0 +1,49 @@
+name: "🚀 CI Build and Deploy"
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  id-token: write
+  contents: write
+  pull-requests: write
+
+jobs:
+  ci-pypi-publish:
+    name: ci-pypi-publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Instalação do Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.10'
+
+      - name: Package Build
+        run: |
+          pip install --upgrade build
+          python -m build
+
+      - name: PyPI Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+  update-release-draft:
+    name: update-relase-draft
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Release Drafter
+        uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          config-name: configs/release-drafter.yml
+
+