Merge pull request #66 from unb-mds/develop

merge develop

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,173 @@
+# Primeiros passos - BACKEND
+
+**Antes de começar a contribuir de fato, veja o guia [Ambiente de Desenvolvimento](https://unb-mds.github.io/2024-1-EducaMinas-frontend/environment/) para configurá-lo corretamente.**
+
+---
+
+Guia para o [**Repositório backend**](https://github.com/unb-mds/2024-1-EducaMinas-backend).
+
+Você pode contribuir com o **EducaMinas** de duas formas: **Relatando um problema** e **Implementando uma funcionalidade**.
+
+## **Relatando um problema**
+
+- Para relatar poblemas no código, abra uma nova issue em nosso [**repositório backend**](https://github.com/unb-mds/2024-1-EducaMinas-backend) no GitHub, com o template **Bug report** e com o _label_ de `bug`.
+- Verifique se já existe alguma issue que reporte o problema encontrado.
+- Preencha as informações solicitadas pelo template.
+- Para relatar problemas na documentação, siga os mesmos passos acima, adicionando o _label_ de `docs`.
+
+---
+
+## **Implementando uma funcionalidade**
+
+Verifique as [**issues do backend**](https://github.com/unb-mds/2024-1-EducaMinas-backend/issues) abertas para encontrar alguma tarefa a ser realizada.
+
+### **Clonar o Repositório**
+
+Para clonar o repositório em um diretório de sua máquina, abra o terminal e execute:
+
+```bash
+git clone https://github.com/unb-mds/2024-1-EducaMinas-backend.git
+```
+
+### **Instalar dependências**
+
+#### **Express/API**
+
+Navegue até o diretório raiz do repositório clonado:
+
+```bash
+cd 2024-1-EducaMinas-backend
+```
+Em seguida instale as dependências do EducaMinas:
+
+```bash
+npm install
+```
+
+#### **Scraper**
+
+Navegue até o diretório `WebScrapper`:
+
+```bash
+cd WebScrapper
+```
+Crie um ambiente virtual com conda:
+
+```bash
+conda create --name <my-env>
+```
+
+Ative o ambiente criado:
+
+```bash
+conda activate <my-env>
+```
+
+Instale as dependências e bibliotecas dentro do ambiente virtual:
+
+```bash
+conda install --yes --file requirements.txt
+```
+
+O script ETL acessa o banco de dados por meio de um `.env` encontrado no caminho
+`WebScrapper/DataETL/.env`. A sua estrutura está escrita abaixo:
+
+```bash
+DATABASE_USERNAME=<INSERIR AQUI>
+DATABASE_PASSWORD=<INSERIR AQUI>
+DATABASE_NAME=<INSERIR AQUI>
+DATABASE_PORT=<INSERIR AQUI>
+DATABASE_HOST=<INSERIR AQUI>
+```
+
+
+### **Criar uma nova Branch**
+
+A partir da branch padrão develop, crie uma nova branch para trabalhar nas modificações, executando:
+
+```bash
+git checkout -b feature/nome-da-issue
+```
+
+Faça as alterações para implementar a tarefa.
+
+### **Executando**
+
+#### **Express/API**
+
+Para executar a aplicação Express em sua máquina, execute no diretório raiz:
+
+```bash
+npm run start
+```
+O servidor será inicializado e estará disponível na porta 3001 do localhost:
+
+```bash
+http://localhost:3001/
+```
+
+Demais comandos para execução de testes, builds e linter podem ser encontrados na guia _scripts_  do arquivo `package.json` na pasta raiz.
+
+Com a api rodando localmente é possível acessar sua documentação e testá-la no **Swagger**, basta acessar:
+
+```bash
+http://localhost:3001/api-docs
+```
+
+#### **Scraper**
+
+Com o ambiente ativado como instruído acima, para extrair os dados do Oracle Data com o selenium execute:
+
+```bash
+DataScraper/InepScrapper.py
+```
+
+#### **ETL**
+
+Para tratar e carregar os dados extraídos, em modo debugger, acesse `WebScrapper/DataETL`, lembre-se de selecionar o ambiente conda que foi criado, e então para rodar o programa por partes, execute:
+
+```bash
+ETLDebugger.ipynb
+```
+
+Se preferir, e não precisar/quiser rodar em modo debugger(por partes), execute o código para produção:
+
+```bash
+python3 WebSrapper/DataETL/main.py
+```
+
+## **Commitar mudanças**
+
+Adicione as alterações feitas:
+
+```bash
+git add nome-dos-arquivos-alterados
+```
+
+Commite as alterações seguindo o padrão das [**Conventional Commits**](https://www.conventionalcommits.org/en/v1.0.0/), com a seguinte estrutura:
+
+```bash
+git commit -m "tipo(#idIssue): descrição"
+```
+
+## **Abrir um Pull Request**
+
+Após fazer seus commits, empurre a branch para o repositório remoto:
+
+```bash
+git push origin nome-da-sua-branch
+```
+
+No GitHub, abra um Pull Request, e preencha o **template** disponível para descrever suas implementações.
+
+## **Revisão e Merge**
+
+O **EducaMinas** conta com três validações padrão para os Pull Requests. Assim, é necessário atendê-las para que sua solicitação seja considerada:
+
+- **Qualidade:** São executados os testes, linter e build para validação básica da qualidade do código.
+- **Cobertura:** A cobertura dos testes é comparada com a cobertura atual, e não deve ser menor.
+- **Review:** Para aprovação, é necessário que ao menos um desenvolvedor faça o code review.
+
+Após a aprovação, o Pull Request será mergeado e suas implementações serão incorporadas ao **EducaMinas**!
+
+---