Welcome to the Penrose wiki! See the sidebar for more pages.

You can find auto-generated documentation for our web runtime here.

If you're new here and interested in contributing to Penrose:

• Try building and running the system
• Check out our list of good first issues
  • Before working on one of them, just let us know that you are interested so we can give you more guidance! (Currently the issue descriptions are fairly brief)
  • Claim an issue
  • Check out a separate branch to work on the issue
  • When your work is ready for review:
    • Open a pull request (PR)
    • Squash your commits into one commit
      • Tag your commit with the branch name: [branch-name] fix/feature description
    • Document your changes in the PR's README (including specific paths for reproducing different examples, and the issue number(s))
    • Make sure the system passes the regression tests
    • Request review from the relevant person
• When your PR is approved, follow this procedure for merging
• For regression tests: (i.e. no matter what, the examples on this page should work)
  • on master, run these examples

Also, you can do some system background reading:

• The Penrose API
• How the Style compiler works
• Contributing to the web runtime

If you hit any snags in the process, run into bugs, or just have questions, please file an issue!