CONTRIBUTING.md

Contributing - Brasil Interface

Summary

• Contributing - Brasil Interface
  • Summary
  • Regras
  • Template de pull-request
  • Como rodar o projeto
    • Instalação
    • Comandos úteis

Regras

• Ao contribuir com mudanças que afetam regras de algoritmos que já foram documentados (com referências), é necessário atualizar a documentação do algoritmo com a nova regra e prover no mínimo uma referência que comprove a nova regra.
• Todo pull-request deve ser feito para a branch develop.
• Todo pull-request deve contar com testes que cubram as mudanças feitas, principalmente cobrindo regras e exceções de algoritmos.

Template de pull-request

Template de pull-request

Como rodar o projeto

Instalação

• Requisitos:
  • nodejs.
  • yarn.
    • Com o node instalado, execute o comando npm install -g yarn para instalar o yarn globalmente.

1. Clone o repositório:

git clone https://github.com/pietrobondioli/brasil-interface.git
cd brasil-interface

2. Instale as dependências:

yarn install

Comandos úteis

1. Rodando os testes:

yarn run test

2. Buildando o projeto:

yarn run build

3. Buildando apenas uma library:

yarn run build:nome-da-library