Contributing to the book

Thank you for considering and taking the time to contribute!

The following is a set of guidelines (borrowed from the Atom project by Github) for contributing to this package. As always use your best judgment and feel free to propose changes to this document in a pull request.

Code of Conduct

What should I know before I get started?

How Can I Contribute?

Additional Notes

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant. By participating, you are expected to uphold this code. Please report unacceptable behavior to Prof. Stephen Wiggins.

What should I know before I get started?

We recommend familiarity with concepts in the prologue chapter of the book and some of the systems presented as case studies.

How Can I Contribute?

We recommend using the Jupyter notebook or Markdown template files for contributing to the book. More details on this process will be added later.

Reporting Bugs

As per open-source modus operandi, open an issue in the Github repository for the book using the standard style listed here.