PlasmaPy / PlasmaPy/plasmapy.github.io

Describe the procedure for creating and approving affiliated packages

Open
#76 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'd be helpful to have a page on our website that talks about members of the community can go about creating an affiliated package. This procedure could be similar to the procedure for Astropy affiliated packages.

We might also want to add coding standards, such as the coding standards for the Python in Heliophysics Community.

💤

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

Review the Astropy affiliated-package procedure and the linked standards.md document first. Then determine the approval steps and coding standards the PlasmaPy website should describe, and confirm the maintainers' decisions before drafting a page. Done means the website contains an agreed, complete procedure for creating and approving affiliated packages.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.