PlasmaPy / PlasmaPy/plasmapy.github.io

Describe how to join PlasmaPy effort as a participating project

Aperta
#36 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

content
Lingua principale
Python
Stelle
17
Fork
24
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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!

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando il sito web e la documentazione esistenti per trovare il luogo appropriato per le informazioni sulla partecipazione dei progetti. Definisci le responsabilità dei progetti partecipanti e del team PlasmaPy supportato da NSF CSSI, inclusi rappresentanti, collaborazione, supporto, formazione e contributi; la documentazione è completa quando queste aspettative sono descritte chiaramente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.