PR guidance

Keep PRs small and focused.

Always pull the latest main before creating a branch.

Run pre-commit hooks locally before committing, this can be automated as outlined in the development page.

Ensure that all functionality is tested before merging.

How to PR review

When reviewing a PR, follow these steps:

  • Confirm that it addresses a specific task or issue.

  • Look for adherence to coding standards (formatting, naming, structure).

  • Verify that the code works as intended.

  • Check for potential issues with the code or potential points of conflict

  • Ensure that changes are modular and don’t introduce unnecessary dependencies.

  • Comment constructively, and ask clarifying questions rather than making assumptions.