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

Framing possible contributions

Aberta
#13 8 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
20/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Domínio
documentation

Direção de pesquisa

Comece revisando o PR #11 e a discussão referenciada nesta issue; em seguida, compare as seções de checklist propostas para os diferentes estilos de documento. Considera-se concluído quando o projeto tiver concordado sobre como as contribuições devem ser estruturadas e onde a orientação ou checklist resultante deve ficar.

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

Descrição

In PR #11, @bjnath, @melissawm, and @cooperrc discussed two topics

  1. Having a template for the tutorials in this repo
  2. Framing the possible contributions into each document style.

Topic 1 is covered by PR #11 so I wanted to bring up topic 2 in a separate issue.

My thoughts on framing the contributions would be to provide a checklist (maybe it could be included in the PR for a tutorial or how-to). I am using a scientific document as a template because I think many users are using NumPy in scientific applications. Scientific documentation also provides a nice structure to present a problem, propose a solution, and show evidence that it works while providing room for future work.

The checklist would also serve to help review and organize the content. Here is a proposed checklist for review (and general feedback):

Introduction

  • Who is the audience
  • What will you learn
  • What is the problem
  • What will you do

Methods

  • What do you need
  • What will you use
  • Are the steps of solution are detailed enough for user
    # Results

# Discussion

Wrapping up

  • Are there any missing pieces or future work?
  • How did NumPy help solve the original problem posed?

# Conclusion

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

Guia de contribuição

Abrir o guia de contribuição

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.