Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Contributing to NumPy: a roadmap for newcomers

Contributing to NumPy: a roadmap for newcomers

Inessa Pawson

June 28, 2022
Tweet

More Decks by Inessa Pawson

Other Decks in Technology

Transcript

  1. Contributing to NumPy A roadmap for newcomers Inessa Pawson NumPy

    Contributor Experience Lead @inessapawson Data for Good - Regina, SK | June 2022
  2. 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).
  3. NUMPY TEAMS maintainers team documentation team web team survey team

    triage team - coming soon translations team - coming soon
  4. What is the best way to start contributing? your skills

    + current project needs P.S. Start small
  5. 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
  6. 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
  7. 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
  8. 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
  9. 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