# pr-open
Open a pull request on github.
Title:
- Use a title that follows Conventional Commits format
Description:
- Include a clear statement of the problem and solution, with an explanation of the high-level
architecture or key decisions made.
- Highlight any breaking changes or important follow-up items
- Link to any related github issues, PRs, or Linear issues.
- Link to related documentation, if any.
- Include example code showing how to use the feature.
- Avoid long lists of files changed
Metadata:
- Apply a github label to the PR. These are helpful when generating release notes later.
If the PR addresses a Linear issue, update the ticket with a link to the Github PR.