nteract/testbook

Add more explicit steps to the Getting Started example

Aberta

#114 aberto em 20 de mai. de 2021

Ver no GitHubGuia do colaborador
 (2 comentários) (1 reação) (0 responsável)Python (38 forks)auto 404
documentationgood first issuesprint-friendly

Métricas do repositório

Stars
 (435 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Improve the Getting Started section of the docs.

Right now it's easy to miss that two files are needed: a notebook (.ipynb file) to test and a test file (.py file) to write the tests.

It would also be helpful to add an explicit step on how to run the test file.

Guia do colaborador

Direção de pesquisa
Revise a documentação de 'Getting Started' atual. Identifique onde adicionar etapas explícitas para criar o arquivo de notebook (.ipynb) e o arquivo de teste (.py). Adicione uma etapa mostrando como executar o arquivo de teste.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90