PlasmaPy / PlasmaPy/plasmapy.github.io

Describe how to join PlasmaPy effort as a participating project

Offen
#36 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

content
Vorherrschende Sprache
Python
Sterne
17
Forks
24
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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!

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie damit, die bestehende Website und Dokumentation zu überprüfen, um die geeignete Stelle für Informationen zur Beteiligung von Projekten zu finden. Legen Sie fest, wofür beteiligte Projekte und das von NSF CSSI unterstützte PlasmaPy-Team verantwortlich sind, einschließlich Vertretung, Zusammenarbeit, Unterstützung, Schulung und Beiträgen; die Dokumentation ist fertig, wenn diese Erwartungen klar beschrieben sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.