numpy / numpy/numpy-tutorials

Framing possible contributions

Open
#13 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
673
Forks
229
PR merge metrics
No merged PRs in 30d

Description

In PR #11, @bjnath, @melissawm, and @cooperrc discussed two topics

  1. Having a template for the tutorials in this repo
  2. Framing the possible contributions into each document style.

Topic 1 is covered by PR #11 so I wanted to bring up topic 2 in a separate issue.

My thoughts on framing the contributions would be to provide a checklist (maybe it could be included in the PR for a tutorial or how-to). I am using a scientific document as a template because I think many users are using NumPy in scientific applications. Scientific documentation also provides a nice structure to present a problem, propose a solution, and show evidence that it works while providing room for future work.

The checklist would also serve to help review and organize the content. Here is a proposed checklist for review (and general feedback):

Introduction

  • Who is the audience
  • What will you learn
  • What is the problem
  • What will you do

Methods

  • What do you need
  • What will you use
  • Are the steps of solution are detailed enough for user
    # Results

# Discussion

Wrapping up

  • Are there any missing pieces or future work?
  • How did NumPy help solve the original problem posed?

# Conclusion

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 PR #11 and the discussion referenced in this issue, then compare the proposed checklist sections for the different document styles. Done means the project has agreed on how contributions should be framed and where the resulting guidance or checklist belongs.

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
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.