CONTRIBUTING.md

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:

• Desafios
• Como configurar o ambiente de desenvolvimento
  • Em Linux
• Testes
• Mantendo

Desafios

Como configurar o ambiente de desenvolvimento

Em Linux

1. Antes de começar a desenvolver, confira se o Tesseract OCR está instalado.

2. Este repositório utiliza ambientes virtuais do Python para isolar seu ambiente de desenvolvimento, pre-commit para formatação de código e também Apache Tika (v1.24.1+) e Tabula (v1.0.4+) na execução de algumas funcionalidades da biblioteca. Ao executar o comando a seguir, você terá tudo isso configurado:

make setup

3. Ative o ambiente de desenvolvimento:

$ source .venv/bin/activate

Testes

Você deve executar os testes com o comando a seguir:

$ make test

O repositório não deveria ter funcionalidades sem testes, quando for modificar algo, verifique se a cobertura de testes ainda está completa com:

$ make coverage

A formatação do código sempre será mantida pelo pre-commit ao realizar commits no projeto. Se desejar verificar se o código que está sendo desenvolvido está formatado adequadamente execute o comando a seguir:

$ make check

E este comando para que as formatações sejam efetuadas sem o auxílio do pre-commit.

$ make format

Mantendo

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