GitHub - pyOpenSci/software-peer-review: pyOpenSci's guidebook for package authors, reviewers, and editors (original) (raw)

pyOpenSci Peer Review Guide

All Contributors

GitHub release (latest by date) DOI deploy-book CircleCI

https://www.pyopensci.org/peer-review-guide/

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

Contributing to this guide

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

To submit a Pull Request with changes:

  1. Create a fork of this repo to make changes.
  2. After making changes, build the book locally from your fork to preview the changes to make sure they appear as expected (see How to build the guide locally below)
  3. When satisfied, push the changes back to GitHub and open a pull request from your fork to the main branch of this repo.
  4. The Continuous Integration processes will build the book and let you and the PR reviewer(s) preview it in your browser (see Automated build and publishing below).
  5. The reviewer of the PR may request modifications.
  6. Once satisfied, the reviewer will merge your pull request! Thanks for your contribution!

How to build the guide locally

The pyOpenSci guidebook is written using Jupyter Book.

To build the guide locally, take the following steps:

git clone https://github.com/pyOpenSci/peer-review-guide  

To build, follow these steps:

  1. Install nox
  2. Build the documentation:

This should create a local environment in a .nox folder, build the documentation (as specified in the noxfile.py configuration), and the output will be in _build/html.

To build live documentation that updates when you update local files, run the following command:

Navigate to _build/html/ on your local clone of the repo and open "index.html".

Automated build and publishing

Whenever a pull request is opened or changes are pushed to any branch of the base repository, the book is built (separately) by both GitHub Actions and CircleCI.

Why both GitHub Actions and CircleCI?

How do you preview the guide from a Pull Request?

preview_book2

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tom Augspurger Tom AugspurgerπŸ’» πŸ‘€ 🎨 Ariane Sasso Ariane SassoπŸ’» πŸ‘€ 🎨 Ryan Abernathey Ryan AbernatheyπŸ’» 🎨 πŸ‘€ David Nicholson David NicholsonπŸ’» πŸ‘€ 🎨 Stefan van der Walt Stefan van der WaltπŸ’» πŸ‘€ 🎨 Erik Welch Erik WelchπŸ’» πŸ‘€ 🎨
Alex Batisse Alex BatisseπŸ’» πŸ‘€ 🎨 Chiara Marmo Chiara MarmoπŸ’» πŸ‘€ 🎨 Yuvi Panda Yuvi PandaπŸ’» 🎨 πŸ‘€ Niels Bantilan Niels BantilanπŸ’» πŸ‘€ Carol Willing Carol WillingπŸ‘€ πŸ’» Chris Holdgraf Chris HoldgrafπŸ‘€ πŸ’» 🎨
Steve Moss Steve MossπŸ‘€ πŸ’» Ivan Ogasawara Ivan OgasawaraπŸ‘€ πŸ’» Kylen Solvik Kylen SolvikπŸ‘€ πŸ’» 🎨 Matthew Brett Matthew BrettπŸ‘€ πŸ’» Zehua Chen Zehua ChenπŸ‘€ πŸ’» Sumit Kashyap Sumit KashyapπŸ’» πŸ‘€
Erik Sundell Erik SundellπŸ‘€ πŸ’» Max Joseph Max JosephπŸ‘€ πŸ’» Ariel Rokem Ariel RokemπŸ‘€ πŸ’» James Mason James MasonπŸ‘€ πŸ’» Juan Luis Cano RodrΓ­guez Juan Luis Cano RodrΓ­guezπŸ’» πŸ‘€ Mahe Iram Khan Mahe Iram KhanπŸ’» πŸ‘€
Qin QinπŸ’» πŸ‘€ David Stansby David StansbyπŸ’» πŸ‘€ P. L. Lim P. L. LimπŸ’» πŸ‘€ Nick Murphy Nick MurphyπŸ’» πŸ‘€ Hans Moritz GΓΌnther Hans Moritz GΓΌntherπŸ’» πŸ‘€ g-patlewicz g-patlewiczπŸ’» πŸ‘€
ruoxi ruoxiπŸ’» πŸ‘€ Gregor Sturm Gregor SturmπŸ’» πŸ‘€ Sean Kelly Sean KellyπŸ’» πŸ‘€ Jesse Mostipak Jesse MostipakπŸ’» πŸ‘€ Tobias Megies Tobias MegiesπŸ’» πŸ‘€ C. Titus Brown C. Titus BrownπŸ’» πŸ‘€
Bane Sullivan Bane SullivanπŸ’» πŸ‘€ Avik Basu Avik BasuπŸ’» πŸ‘€

This project follows the all-contributors specification. Contributions of any kind welcome!