- Commit early, commit often.
- Write good commit messages.
- Create draft pull requests for in-progress work.
- Try to keep pull requests small if possible, since it makes review easier.
Please follow these guidelines when reviewing PRs.
- Once you think your code is ready to merge, mark your draft pull request as “ready for review” or create a pull request if you don’t have a draft. The required reviewers will automatically be notified when you do this.
- Please post in
#code-review:matrix.mathesar.org and tag the handles of the Mathesar engineering team (see Team) when you have a PR ready for review.
- If the reviewer requests changes, please make the changes and re-request review.
- Do not resolve comments, let the reviewer do this.
Anyone is welcome to review pull requests!
- Request changes if you want another look at the PR before it is merged.
- Resolve your own comments, do not resolve anyone else’s.
- If the branch needs to be updated before merging (because it’s out-of-date with the
master branch), do so, as long as the merge can be performed automatically. Otherwise, ask the Author to handle it.
- See Backend Code Review for guidelines specific to backend code.
- Check for outstanding PRs at least once a day.
- Review core team PRs within 1 work day, community PRs within 3 work days.
- If you approve the PR, merge it unless someone else has requested changes.
- If the person who has requested changes is unavailable, merge the PR anyway.
- Always merge using merge commits, never squash or rebase (the GitHub interface should disable squash and rebase, but check just in case).
Some reading related to our process: