Skip to main content

PR Template

· One min read

We've updated our PR template with known issues and guidance on how to handle them. This was a request from contributors, as the PR template is a natural place to surface this information.

What It Does​

Whenever you open a PR, an automatic template is created for contributors to fill in with details about the scope of their work. This update adds a new informational section that highlights known issues in the CI pipeline and provides steps on how to address them.

PR_Template

PR_Template_Acc

PR_Template_Visual

Important Notes​

We're currently testing this approach in the PR template. If you think this information would be more effective elsewhere, let the maintainers know!

Why This Matters​

Some CI workflows fail intermittently on contributor PRs due to issues maintainers are actively investigating. The known issues section acts as a preventive measure, helping contributors stay focused on their work and quickly determine whether test, baseline, or workflow inconsistencies are related to their changes or to a pre-existing issue.