Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (47 loc) · 4.57 KB

CONTRIBUTING.md

File metadata and controls

68 lines (47 loc) · 4.57 KB

Português (BR) | English (US)

Contribuindo

O Querido Diário possui um Guia para Contribuição principal que é relevante para todos os seus repositórios. Este guia traz informações gerais sobre como interagir com o projeto, o código de conduta que você adere ao contribuir, a lista de repositórios do ecossistema e as primeiras ações que você pode tomar. Recomendamos sua leitura antes de continuar.

Já leu? Então vamos às informações específicas deste repositório:

Arquitetura

arquitetura

Uma breve descrição dos componentes do repositório:

Tipo Nome Descrição Dependências
Módulo config Configurações do Django e Celery.
Módulo libs Contratos e implementações de APIs externas.
Serviço libs/ibge Consultas à API de cidades do IBGE.
Serviço libs/querido_diario Consultas à API aberta do Querido Diário.
Aplicação accounts Gerenciamento de informações básicas e de autenticação de usuários.
Aplicação querido_diario API intermediária de consultas ao Querido Diário.
Aplicação alerts Gerenciamento de alertas de busca. accounts, libs/ibge
Recurso Postgres Banco de dados principal. Contém informações básicas de usuários e alertas.
Recurso Redis Banco de dados utilizado para processamento de tarefas assíncronas como o envio de alertas.

Como configurar o ambiente de desenvolvimento

O projeto utiliza Django, Django REST frawework, Celery, Redis e Postgres. Para saber as versões do Django, DRF e Celery, verifique o requirements.txt. As versões dos bancos de dados são as mais recentes disponíveis.

A seguir, veja como instalar todas essas ferramentas em seu sistema operacional.

  1. Instale o podman e verifique a versão do Python (3.6+)

  2. Com o Python e podman instalados, ative o ambiente virtual:

python3 -m venv .venv
source .venv/bin/activate

Observação: Em Windows, o segundo comando deve ser substituído por .venv/Scripts/activate.bat o sentido da barra (/ ou \) pode variar a depender da utilização de WSL).

  1. Instale as dependências de desenvolvimento para poder interagir com a interface de linha de comando disponível em cli:
pip install -r requirements-dev.txt
  1. Agora, para fazer o setup do projeto (instalar pre-commit, criar variáveis de ambiente e containers), execute:
python -m cli setup

Para mais informações sobre a interface de linha de comando, execute:

python -m cli --help
  1. Pronto! Agora você já pode começar a editar o código.

Mantendo

As pessoas mantenedoras devem seguir as diretrizes do Guia para Mantenedoras do Querido Diário.