/contributing-guide

pyOpenSci's guidebook for package authors, reviewers, and editors

Primary LanguageCSSOtherNOASSERTION

pyOpenSci Guidebook

CircleCI

https://pyopensci.org/contributing-guide/

pyOpenSci's guide for developing, reviewing, and maintaining packages.

Build the guide locally

The pyOpenSci guidebook is written using Jupyter Books.

To build the guide locally, take the following steps:

  • Clone this repository:

    git clone https://github.com/pyOpenSci/contributing-guide

  • Install Jupyter Book

    pip install -U "jupyter-book>=0.7.0b"

  • Build the guide

    # Cd to the repo if you are not already in it!
cd contributing-guide
# Build the book locally!
jupyter-book build .

Contributing to this guide

We welcome and issues and pull-requests to improve the content of this guide. If you'd like to see an improvement, please open an issue.