Skip to content

Templates

PR template definitions for different workflow strategies.

DEFAULT_PR_TEMPLATE module-attribute

DEFAULT_PR_TEMPLATE = {
	"title": "{branch_type}: {description}",
	"description": "## Description\n\n{description}\n\n## Changes\n\n-\n\n## Related Issues\n\n-\n",
}

GITHUB_FLOW_PR_TEMPLATE module-attribute

GITHUB_FLOW_PR_TEMPLATE = {
	"title": "{description}",
	"description": "## Description\n\n{description}\n\n## What does this PR do?\n\n<!-- Please include a summary of the change and which issue is fixed. -->\n\n## Changes\n\n-\n\n## Screenshots (if appropriate)\n\n## Testing completed\n\n- [ ] Unit tests\n- [ ] Integration tests\n- [ ] Manual testing\n\n## Related Issues\n\n<!-- Please link to any related issues here -->\n\n- Closes #\n",
}

TRUNK_BASED_PR_TEMPLATE module-attribute

TRUNK_BASED_PR_TEMPLATE = {
	"title": "{description}",
	"description": "## Change Description\n\n{description}\n\n## Implementation\n\n<!-- Briefly describe implementation details -->\n\n-\n\n## Test Plan\n\n<!-- How was this tested? -->\n\n- [ ] Unit tests added/updated\n- [ ] Integration tested\n\n## Rollout Plan\n\n<!-- How should this be deployed? -->\n\n- [ ] Can be deployed immediately\n- [ ] Requires feature flag\n- [ ] Requires data migration\n\n## Related Issues\n\n- Fixes #\n",
}

GITFLOW_PR_TEMPLATES module-attribute

GITFLOW_PR_TEMPLATES = {
	"feature": {
		"title": "Feature: {description}",
		"description": "## Feature Description\n\n{description}\n\n## Implemented Changes\n\n-\n\n## Testing Performed\n\n- [ ] Unit tests\n- [ ] Integration tests\n- [ ] Manual testing\n\n## Related Issues\n\n- Closes #\n",
	},
	"release": {
		"title": "Release {description}",
		"description": "## Release {description}\n\n### Features\n\n-\n\n### Bug Fixes\n\n-\n\n### Breaking Changes\n\n-\n\n## Deployment Notes\n\n-\n\n## Testing Required\n\n- [ ] Smoke tests\n- [ ] Regression tests\n- [ ] Performance tests\n",
	},
	"hotfix": {
		"title": "Hotfix: {description}",
		"description": "## Hotfix: {description}\n\n### Issue Description\n\n<!-- Describe the issue being fixed -->\n\n### Fix Implementation\n\n<!-- Describe how the issue was fixed -->\n\n-\n\n### Testing Performed\n\n- [ ] Verified fix locally\n- [ ] Added regression test\n\n### Impact Analysis\n\n- Affected components:\n- Risk assessment:\n",
	},
	"bugfix": {
		"title": "Fix: {description}",
		"description": "## Bug Fix\n\n### Issue Description\n\n{description}\n\n### Root Cause\n\n<!-- What caused the bug? -->\n\n### Fix Implementation\n\n-\n\n### Testing Performed\n\n- [ ] Added test case that reproduces the bug\n- [ ] Verified fix locally\n\n### Related Issues\n\n- Fixes #\n",
	},
}