Framing possible contributions
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 673
- Forks
- 229
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
In PR #11, @bjnath, @melissawm, and @cooperrc discussed two topics
- Having a template for the tutorials in this repo
- 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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando el PR #11 y la discusión referenciada en este issue; después, compara las secciones de checklist propuestas para los distintos estilos de documento. Se considera terminado cuando el proyecto haya acordado cómo deben plantearse las contribuciones y dónde debe ubicarse la guía o checklist resultante.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100