Contributing to NumPy: a roadmap for newcomers

Slide 1

Slide 1 text

Contributing to NumPy A roadmap for newcomers Inessa Pawson NumPy Contributor Experience Lead @inessapawson Data for Good - Regina, SK | June 2022

Slide 2

Slide 2 text

NumPy is a Python library that is the de facto standard for multidimensional arrays in Python data science. NumPy offers comprehensive mathematical functions, random number generators, linear algebra routines, Fourier transforms, and more. It lies at the core of a rich ecosystem of data science libraries. Source: Harris, C.R., Millman, K.J., van der Walt, S.J. et al. Array programming with NumPy. Nature 585, 357–362 (2020).

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

NUMPY TEAMS maintainers team documentation team web team survey team triage team - coming soon translations team - coming soon

Slide 5

Slide 5 text

What is the best way to start contributing? your skills + current project needs P.S. Start small

Slide 6

Slide 6 text

contribute graphic design translations (Portuguese, Spanish, Japanese, Chinese) CONTRIBUTE TO NUMPY filing issues improving documentation conducting user surveys develop educational material review pull requests triage issues

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

Slide 9

Slide 9 text

NumPy under the hood

Slide 10

Slide 10 text

Prerequisite knowledge to submit a documentation-related PR to numpy/numpy 1. how to use git and GitHub 2. how to build NumPy development environment and NumPy documentation or use Gitpod

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

Good usage examples in a docstring - concise - descriptive - cover corner cases - show all keywords in action - mention interpretation results - 1-3 examples per a docstring

Slide 13

Slide 13 text

Slide 14

Slide 14 text

NumPy community events biweekly COMMUNITY CALLS biweekly DOCS TEAM MEETINGS biweekly TRIAGE CALLS biweekly NEWCOMER'S HOUR

Slide 15

Slide 15 text

Twitter: @InessaPawson GitHub: @InessaPawson