CONTRIBUTING.md

Contribuindo com a Minha Receita

Escreva testes, rode os testes e reconstrua os containers para saber se está tudo certo. Se for utilizar Docker, copie o arquivo .env.sample como .env — e ajuste, se necessário.

$ go test ./...
$ docker-compose build

Documentação

Utilizamos o Material for MkDocs:

$ docker pull squidfunk/mkdocs-material
$ docker run --rm -v $(pwd):/docs squidfunk/mkdocs-material build

A documentação vai ser gerada em site/index.html. Para servir enquanto desenvolve:

$ docker run -p 8000:8000 --rm -v $(pwd):/docs squidfunk/mkdocs-material serve --dev-addr 0.0.0.0:8000