Back to Contributing / Dev Guide
These guidelines will help me review PRs more quickly:
- Please use Github's UI to request review, so I know when I should look at a PR.
- Add
andychu as reviewer in the upper right.
- (This is a new thing as of 2025-11)
- Please write a good commit description:
- What changed? This can be written for a user to read. (TODO: we should come up with an automated release notes system)
- How did you test it? Often this is via spec tests, but not always.
- Do docs need to be updated?
- Feel free to ask for help / tips on this.
- I will use Github's system to make comments. After addressing them, please:
- Push the commits so I can see them
- Reply with a message, like "All done", or "I disagree because ..."
- Click on the upper right to re-request review, so it appears in my list of things to review
If you only push commits, I won't look at the PR again, because I'll assume it's in progress.
Also, please feel free to ask questions even if the PR isn't ready for review yet! There are often many different files to modify.
I aim for a initial response in 24 hours, so feel free to ping me after that. (As of 2025-11, the delay has been a bit longer on occasion. But still feel free to ping me.)
TODO
- Instructions on using the CI
- Types of tests and our standards for testing
Note: Send PRs from oils-for-unix/oils and not your own fork, so that Github Actions can get our $TOIL_KEY, and publish HTML results to https://op.oilshell.org/
Link