Add an extra script in `Contributing` to install some of the extra `Doc` requirements i.e. to make it easier to dev & QA
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 18.8k
- Forks
- 2.8k
- Merge médio
- 16h 26min
- PRs com merge (30d)
- 21
Descrição
Using these commands from Contributing
(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
won't install modules e.g. wget, datashader, etc. that are used in docs.
I suggest we add optional-doc-requirements.txt to help install some of these modules so that we could more efficiently test the examples using:
jupyter-notebook doc/python
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pela seção “Install requirements — non-windows” de contributing.md e pelos arquivos existentes packages/python/plotly/requirements.txt e optional-requirements.txt. Revise os exemplos de documentação em doc/python e identifique os módulos adicionais usados neles, incluindo wget e datashader. O trabalho estará concluído quando um arquivo optional-doc-requirements.txt e instruções atualizadas para contribuidores permitirem que os exemplos sejam testados com jupyter-notebook doc/python.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- jupyter-notebook, python
- Domínio
- documentation
- Tipo de issue
- Funcionalidade
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 55/100