PlasmaPy / PlasmaPy/plasmapy.github.io

Describe how to join PlasmaPy effort as a participating project

Open
#36 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
Python
Stars
17
Forks
24
PR merge metrics
No merged PRs in 30d

Description

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!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing website and documentation to find the appropriate place for information about participating projects. Define what participating projects and the NSF CSSI-supported PlasmaPy team are responsible for, including representatives, collaboration, support, training, and contributions; the documentation is done when these expectations are clearly described.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.