PlasmaPy / PlasmaPy/plasmapy.github.io

Describe how to join PlasmaPy effort as a participating project

Abierto
#36 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

content
Lenguaje dominante
Python
Estrellas
17
Forks
24
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

It would be helpful for our website (or perhaps documentation) to describe how a research group or experiment can officially become a participating project. This would effectively be a partnership, with responsibilities shared between the core developers and the participating project.

We should describe what it means to be a participating project, including what the responsibilities of the participating projects are. Some possibilities:

  • Appoint one or two people to be representatives for the project to PlasmaPy [who will ask us questions, answer questions from us, request features, (preferably) contribute code/docs/tests now and then, share knowledge with the rest of their team, etc.]
  • Create use cases specific for their project to help us collaboratively design workflows
  • A commitment to develop (especially experimental or simulation) analysis software to be compatible with PlasmaPy over next few years (though not necessarily all of their software)
  • Participate in planning discussions on the future of PlasmaPy

We should also describe what those of us on the NSF CSSI grant will be responsible for (i.e., user support, developer support, providing trainings, quick/constructive code reviews, etc.).

These are initial thoughts, so suggestions on how we should go about this are welcome!

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza revisando el sitio web y la documentación existentes para encontrar el lugar adecuado para incluir información sobre la participación de proyectos. Define de qué son responsables los proyectos participantes y el equipo de PlasmaPy apoyado por NSF CSSI, incluidos los representantes, la colaboración, el apoyo, la formación y las contribuciones; la documentación estará terminada cuando estas expectativas estén descritas claramente.

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
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.