numpy / numpy/numtype

move test `README.md` into the contributor's guide

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

Nobody has claimed this yet.

topic: documentation topic: testing
Dominant language
Python
Stars
79
Forks
8
PR merge metrics
No merged PRs in 30d

Description

It might be cleanest to do so as a subpage of it, which'd require tweaking the current page- and nav-structure

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 locating the test README.md and the contributor's guide, then inspect the current page and navigation structure. Move the README content into the guide as a subpage, update the page and navigation structure, and verify that the resulting documentation links and layout work.

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.