PlasmaPy / PlasmaPy/plasmapy.github.io

State how to cite PlasmaPy on the front page

Open
#90 1 comment 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

We should have a short section on the front page that states how to cite PlasmaPy, and links to the corresponding page in the docs (which are the canonical citation instructions). There's a paragraph on the README for the main PlasmaPy repo that might be good to include here.

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 paragraph on the main PlasmaPy repository README and the corresponding canonical citation page in the docs. Locate the website front page, add a short citation section linking to that documentation, and verify that the link and wording are correct.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.