Skip to content

Latest commit

 

History

History
16 lines (11 loc) · 620 Bytes

CONTRIBUTING.md

File metadata and controls

16 lines (11 loc) · 620 Bytes

Contribuindo

Para contribuir com o pacote com a inserção de um novo documento:

  • Crie uma issue dizendo sobre o documento que deseja inserir ao pacote;
    • Preferencialmente coloque links que ajudem a entender o algoritmo de geração e válidação do documento.
  • Realize os procedimentos padrões, sendo que na hora de criar a sua branch, referencie a sua issue;
  • Realize o pull request para a branch master.

Sobre o código

Para novos documentos:

  • Criar uma classe com as siglas do documento (herdando a classe pai BaseDoc);
  • Importar a classe no __init__.py;
  • Criar testes em test/.