Contributor guide - penrose/penrose Wiki
If you're new here and interested in contributing to Penrose:
Building and Running
Refer to the building and running page to learn how to build and run the system.
Creating your fork of
To fork the
penrose repository on GitHub, click the "Fork" button on the top-right of the repo homepage.
Then, clone your forked repo locally
git clone https://github.com/<your-github-account-name>/penrose.git
If you need to merge new changes from upstream (i.e. the original
penrose repo) with your fork:
cd penrose git checkout main git pull https://github.com/penrose/penrose.git main
After running the above, manage any merge conflicts, commit them, and then push them to your fork.
Finding an issue to work on
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
- Create a separate branch in your forked repo to work on the issue
Opening a pull request (PR)
When your work is ready for review:
- Open a pull request (PR) by clicking on the
Contributebutton on the homepage of your forked repo (
feat:to the PR title depending on whether it's a fix or feature. We follow conventional commit guidelines in our repo.
- 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
- Run Prettier via
yarn formatin the repository root
- Request review from the relevant person
- When your PR is approved, follow this procedure for merging
If you hit any snags in the process, run into bugs, or just have questions, please file an issue!