PlasmaPy / PlasmaPy/plasmapy.github.io

Write quickstart guide

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

Nobody has claimed this yet.

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

Description

I'm commenting out a few pages that won't be shown right now, so I'm adding these here. Likely some duplication with #6.

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 issue #6 and the pages mentioned in this issue. Clarify which pages should remain and how the quickstart guide differs from existing content; the work is done when the intended guide scope and pages to update are agreed.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.