lincc-frameworks / lincc-frameworks/python-project-template
Nice to have: a page in the PPT docs with basics of OOP, modules, rel imports, etc
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Jinja
- Estrelas
- 85
- Forks
- 16
- Merge médio
- 6h 18min
- PRs com merge (30d)
- 1
Descrição
Inspired by incubee. I think this would be nice for other scientists too, or even anyone used to OOP but not 100% familiar with Python-specific syntax.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
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 revisando a estrutura existente da documentação do PPT e as páginas destinadas a usuários de software científico. Adicione uma página que aborde a sintaxe de OOP específica do Python, módulos e imports relativos, com fundamentos suficientes para ajudar leitores familiarizados com OOP em outros ambientes; considera-se concluído quando a página estiver integrada à documentação e cobrir os tópicos solicitados.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Pouca atividade
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 68/100