Contributing to paper-land and Paper Playground¶

This document is incomplete and will be continually updated

First of all, thank you for checking out our project and considering contributing.

We welcome any contributions to the project, including:

Example Programs¶

• Please share any Programs you create that you would like to share! Add a new post to the Show and Tell section of the paper-land Discussion forum with your code and any additional information to make use of it.
• We may include your examples in the hard-coded example sets to share with more users.

Documentation¶

Contributions do not have to be code. We welcome any updates to documentation that will help others get more use out of Paper Playground. This includes, but is not limited to:

• Creator Tutorial updates
• Implementation and API documentation
• Example and use-case documentation or video demonstration
• Updates or fixes to the landing page (localhost:3000)
• Updates to the documentation structure/website

Translations are also welcome, but the project is currently under heavy development and they may become stale quickly.

To make any contributions, please open an issue if one does not exist and then open a pull request with your changes.

Features or bug fixes to the tool¶

• See WISHLIST.md
• Search open issues by the wishlist label or good first issue label

• Open an issue or discuss with us what you'd like to work on!

• Please create an issue if one does not exist.

• Fork the project and make any changes.
• Run any tests including lint before opening a pull request
• Open a pull request

After the feature has been added, please consider opening a pull request to change WISHLIST.md to remove the completed item!

To make any contributions not otherwise listed, please open an issue if one does not exist or open up the idea on the Discussion forum.