Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

DOC: update contributing guide to reflect the preferred practice

Aberta
  • Algo errado?
#186 4 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Domínio
documentation

Direção de pesquisa

Leia o guia de contribuição atual e o README para ver onde as práticas relacionadas a notebooks estão documentadas. Atualize as orientações para declarar que os notebooks não devem conter saídas e que arquivos .md são preferidos em vez de .ipynb; considera-se concluído quando a estrutura escolhida para o guia refletir claramente ambos os pontos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

documentation infrastructure

Currently missing points:

  • No outputs should be included in the notebooks
  • we do prefer .md files as opposed to .ipynb.

Maybe the updated guide should be in a separate file, and keep the absolute newcomer version, that we currently have, in the README?

Linguagem predominante
Sem dados de linguagem
Estrelas
682
Forks
229
Nenhum PR com merge em 30d

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de numpy/numpy-tutorials

Todas as issues de numpy/numpy-tutorials

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.