Correcting file upload.

[dnlcesilva]

Changing the read_indo_dataframe function in datasets.py.

[github-actions]

Dicas para revisão de código

Commits

• Título (1a linha do commit): apresentar resumo do que foi alterado/adicionado/removido.
  ex: adiciona action que salva parametros no backend; exibe rótulo no componente de selecao de dataset;
• Descrição (outras linhas): dar mais detalhes de cada alteração:
• motivos das alterações
  ex: havia um bug que causava...; nova funcionalidade que faz isso...; código foi movido para...;
• bibliotecas adicionadas e versões (requirements.txt)
  ex: atualiza para minio 6.0.0;
• testes unitários criados/alterados
  ex: adiciona testes para a API POST /datasets;
• alterações do swagger.yaml
  ex: adiciona documentação para GET /datasets
• Mensagens auto-explicativas! Quem revisa o código deve entender o que foi feito (e porque foi feito) sem perguntar para quem fez o commit.
• Não devem ter conflitos. Solicitar que sejam resolvidas as ocorrências de "This branch has conflicts that must be resolved".

SonarCloud Quality Gate

• Coverage > 80.0%, e sempre que possível = 100%
• 0 Bugs, 0 Code Smells, 0 Vulnerabilities
• São permitidos os seguintes Security Hotspots:
• Make sure this permissive CORS policy is safe here.
• Make sure publicly writable directories are used safely here.
• Using http protocol is insecure. Use https instead.
• Make sure disabling CSRF protection is safe here.

Build Github actions COM SUCESSO

Python

• Usar Python>=3.7
• Remover print.
• Não deixar código-fonte comentado.
• f-string f'text-{variable}' é melhor que 'text-{}'.format(variable) e 'text-' + variable
• Métodos que são chamados de outros arquivos .py DEVEM TER Docstring.
• Usar NumPy Style Python Docstring: https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html
• Usar sempre import absoluto.
  ex: from datasets.samples import init_datasets (BOM), from .samples import init_datasets (RUIM)

Padrão de URLs para API REST

• Usar REST resource naming guide: https://restfulapi.net/resource-naming/
• USE SUBSTANTIVOS! NÃO USE VERBOS NA URL!
  ex: /datasets/:projectId/uploads (BOM), /dataset/upload (RUIM)
• SUBSTANTIVOS SEMPRE NO PLURAL!
  ex: /datasets/:datasetId (BOM), /dataset/:datasetId (RUIM)
• SUBSTANTIVOS SÃO SEMPRE SEPARADOS POR UM ID. NÃO USE DOIS SUBSTANTIVOS SEGUIDOS
  ex: /datasets/:datasetId/columns (BOM), /datasets/columns/:datasetId (RUIM)
• Para consultar uma lista de resources (paginada ou não):
  ex: GET /resources?page=1&size=10&filter=...
• Para criar um resource (e gerar um resourceId aleatório):
  ex: POST /resources
• Para acessar um resource por resourceId:
  ex: GET /resources/{resourceId}
• Para substituir/criar (ou atualizar TODOS OS CAMPOS) de um resource com resourceId específico:
  ex: PUT /resources/{resourceId}
• Para excluir um resource:
  ex: DELETE /resources/{resourceId}
• Para atualizar alguns campos de um resource:
  ex: PATCH /resources/{resourceId}
• Em dúvidas? Mantenha uma consistência com as URLs já existem.

[github-actions]

Dicas para revisão de código

Commits

• Título (1a linha do commit): apresentar resumo do que foi alterado/adicionado/removido.
  ex: adiciona action que salva parametros no backend; exibe rótulo no componente de selecao de dataset;
• Descrição (outras linhas): dar mais detalhes de cada alteração:
• motivos das alterações
  ex: havia um bug que causava...; nova funcionalidade que faz isso...; código foi movido para...;
• bibliotecas adicionadas e versões (requirements.txt)
  ex: atualiza para minio 6.0.0;
• testes unitários criados/alterados
  ex: adiciona testes para a API POST /datasets;
• alterações do swagger.yaml
  ex: adiciona documentação para GET /datasets
• Mensagens auto-explicativas! Quem revisa o código deve entender o que foi feito (e porque foi feito) sem perguntar para quem fez o commit.
• Não devem ter conflitos. Solicitar que sejam resolvidas as ocorrências de "This branch has conflicts that must be resolved".

SonarCloud Quality Gate

• Coverage > 80.0%, e sempre que possível = 100%
• 0 Bugs, 0 Code Smells, 0 Vulnerabilities
• São permitidos os seguintes Security Hotspots:
• Make sure this permissive CORS policy is safe here.
• Make sure publicly writable directories are used safely here.
• Using http protocol is insecure. Use https instead.
• Make sure disabling CSRF protection is safe here.

Build Github actions COM SUCESSO

Python

• Usar Python>=3.7
• Remover print.
• Não deixar código-fonte comentado.
• f-string f'text-{variable}' é melhor que 'text-{}'.format(variable) e 'text-' + variable
• Métodos que são chamados de outros arquivos .py DEVEM TER Docstring.
• Usar NumPy Style Python Docstring: https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html
• Usar sempre import absoluto.
  ex: from datasets.samples import init_datasets (BOM), from .samples import init_datasets (RUIM)

Padrão de URLs para API REST

• Usar REST resource naming guide: https://restfulapi.net/resource-naming/
• USE SUBSTANTIVOS! NÃO USE VERBOS NA URL!
  ex: /datasets/:projectId/uploads (BOM), /dataset/upload (RUIM)
• SUBSTANTIVOS SEMPRE NO PLURAL!
  ex: /datasets/:datasetId (BOM), /dataset/:datasetId (RUIM)
• SUBSTANTIVOS SÃO SEMPRE SEPARADOS POR UM ID. NÃO USE DOIS SUBSTANTIVOS SEGUIDOS
  ex: /datasets/:datasetId/columns (BOM), /datasets/columns/:datasetId (RUIM)
• Para consultar uma lista de resources (paginada ou não):
  ex: GET /resources?page=1&size=10&filter=...
• Para criar um resource (e gerar um resourceId aleatório):
  ex: POST /resources
• Para acessar um resource por resourceId:
  ex: GET /resources/{resourceId}
• Para substituir/criar (ou atualizar TODOS OS CAMPOS) de um resource com resourceId específico:
  ex: PUT /resources/{resourceId}
• Para excluir um resource:
  ex: DELETE /resources/{resourceId}
• Para atualizar alguns campos de um resource:
  ex: PATCH /resources/{resourceId}
• Em dúvidas? Mantenha uma consistência com as URLs já existem.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication

[fberanizo]

👍