Describe how to join PlasmaPy effort as a participating project

オープン
#36 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
領域
documentation

調査の方向性

まず、既存のウェブサイトとドキュメントを確認し、参加プロジェクトに関する情報を掲載する適切な場所を見つけます。参加プロジェクトとNSF CSSIに支援されているPlasmaPyチームが、代表者、協力、サポート、トレーニング、貢献を含めて何に責任を負うのかを定義します。これらの期待事項が明確に記述されれば、ドキュメントは完成です。

索引モデルが issue の本文から書いたものです。

説明

content

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!

主要言語
Python
スター
17
フォーク
24
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

PlasmaPy/plasmapy.github.io のほかの issue

PlasmaPy/plasmapy.github.io の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。