Contribution Guide

Welcome to the Contributor’s Guide to pystencils! If you are interested in contributing to the development of pystencils, this is the place to start.

Pystencils is an open-source package licensed under the AGPL v3. As such, the act of contributing to pystencils by submitting a merge request is taken as agreement to the terms of the licence.

• Development Workflow
  • Prepare the Git Repository
  • Set Up the Python Environment
  • Static Code Analysis
  • Running the Test Suite
  • Building the Documentation
• Testing pystencils
  • Running the Testsuite
  • Extending the Test Suite
  • Testing with the Experimental CPU JIT