henriqueajnb/data-science-escalavel

Translation to brazilian portuguese of the book Build a Reproducible and Maintainable Data Science Project from Khuyen Tran author.

data-science-escalavel's Issues

Definir padrões para colaboração

Definir alguns padrões para colaboração como mensagens de commits seguindo o commit-zen, e outros padrões a serem definidos.

Erro com o diretório "data" quando rodam "make setup"?

O template original do cookiecutter tem algumas linhas de git para limpar o cache dentro do target install do Makefile:

...
git rm -r --cached 'data/raw'
git rm -r --cached 'data/processed'
git rm -r --cached 'data/final'
git rm -r --cached 'models'
...

Pelo menos aqui quando fui rodar essa parte levantou erro de arquivo não encontrado. A nossa tradução removeu essas linha e pelo visto é isso que resolve o problema. Alguém mais teve esse problema?

Criar imagem no Miro

Criar imagem da estrutura de pasta inicial, ainda está como a original da autora.

Padronizar as seções de comentário à parte

Regravar gif `02-make.gif`

Regravar gif 02-make.gif. Trecho de fundo aparecendo na lateral direita.

Tornar todo o texto pessoal

O livro contém vários trechos de uso de linguagem pessoal com pronomes e conjugações em primeira pessoa. O ideal seria transformar todo texto para a forma impessoal

Colocar imagem na seção 3.1 de pytest

Procurar por uma imagem adequada diferente da autora original para colocar no início da seção

Adicionar dark mode ao jupyter book?

Para melhorar a acessibilidade e não cansar a vista, podemos adicionar um estilo com dark mode sobre o backend do jupyter book?

Sugestão: Quantecon Book Theme

No canto superior direito desse exemplo tem um botão que troca para o dark mode.

Enumerar imagens e gifs para serem compatíveis com capítulos e seções

Eu iniciei numerando-os em ordem de colocação no livro, mas essa forma dificulta a localização da alocação da imagem ou gif no livro.

Ideal seria enumerar os nomes das imagens com capítulo + seção.

Exemplo: 01-1-cookiecutter_template.png.

Desta forma, saberemos facilmente que esta imagem está alocada no capítulo 01 seção 1.

Imagens ilegíveis em cap03-testes_unitarios/sec3-2-dicas_pytest

Os prints do terminal nesta seção estão ilegíveis. Considerar substituí-los. Relacionado ao issue #38.

Padronizar tamanho dos gifs

Regravar todos os gifs com o tamanho padrão definido como 85 x 20 e fonte do terminal tamanho 16

Padronizar prints do terminal com Carbon

Os prints com Carbon ficam bem mais elegantes, seria ideal padronizar as imagens com tema definido. Assim todos conseguem contribuir... =)

SVG não está carregando de forma interativa

O SVG 08-benchmark_histogram.svg do arquivo book/cap03-testes_unitarios/sec3-2-dicas_pytest.md não está carregando. Fiz um PR adicionando a imagem por meio do raw.git, mas ela ainda continua sem interatividade. É preciso adicionar ela de forma que mantenha a interação.