This commit is contained in:
DevRunbook release export
@@ -0,0 +1,192 @@
|
||||
apiVersion: devrunbook.io/v1alpha1
|
||||
kind: Playbook
|
||||
metadata:
|
||||
id: git-gitea.pull-request-template
|
||||
slug: pull-request-template
|
||||
version: 1.0.0
|
||||
title: Create Pull Request Template and Review Checklist
|
||||
summary: Add a concise pull-request template aligned with repository validation, risk and documentation needs.
|
||||
category: git-gitea
|
||||
tags:
|
||||
- git
|
||||
- pull-request
|
||||
- review
|
||||
lifecycle: reviewed
|
||||
riskTier: low
|
||||
authors:
|
||||
- name: DevRunbook Core Team
|
||||
license: MIT
|
||||
package:
|
||||
files:
|
||||
- path: prompt.md
|
||||
role: template
|
||||
digest: true
|
||||
exportByDefault: false
|
||||
- path: README.md
|
||||
role: documentation
|
||||
digest: true
|
||||
exportByDefault: false
|
||||
- path: CHANGELOG.md
|
||||
role: changelog
|
||||
digest: true
|
||||
exportByDefault: false
|
||||
- path: examples/minimal.yaml
|
||||
role: example
|
||||
digest: true
|
||||
exportByDefault: false
|
||||
- path: evaluations/static-structure.yaml
|
||||
role: evaluation
|
||||
digest: true
|
||||
exportByDefault: false
|
||||
spec:
|
||||
type: quick
|
||||
intent:
|
||||
problem: Development work around create pull request template and review checklist is often underspecified, inconsistently
|
||||
executed or reported without enough evidence.
|
||||
outcome: Add a concise pull-request template aligned with repository validation, risk and documentation needs.
|
||||
whenToUse:
|
||||
- Use this playbook when the repository needs a bounded create pull request template and review checklist task with explicit
|
||||
evidence and completion criteria.
|
||||
- Use it when Codex should follow a repeatable workflow rather than improvise from a one-line request.
|
||||
whenNotToUse:
|
||||
- Do not use it when the desired outcome or authority boundaries are still materially undecided.
|
||||
- Do not use it to access unavailable production credentials, bypass safeguards or claim validation that cannot be performed.
|
||||
modes:
|
||||
- guided
|
||||
- execute
|
||||
- recovery
|
||||
defaultMode: execute
|
||||
autonomy:
|
||||
min: implement
|
||||
max: repair
|
||||
default: verify
|
||||
inputs:
|
||||
- key: requiredChecks
|
||||
label: Required checks
|
||||
description: List checks contributors must complete or acknowledge before review.
|
||||
type: string-list
|
||||
required: true
|
||||
sensitive: false
|
||||
includeInOutput: true
|
||||
- key: riskAreas
|
||||
label: Risk areas
|
||||
description: List product or repository risks that reviewers should inspect explicitly.
|
||||
type: string-list
|
||||
required: false
|
||||
sensitive: false
|
||||
includeInOutput: true
|
||||
default: []
|
||||
compatibility:
|
||||
repositoryRequired: true
|
||||
languages: []
|
||||
frameworks: []
|
||||
packageManagers: []
|
||||
databases: []
|
||||
deploymentTypes: []
|
||||
requiredProfileCapabilities: []
|
||||
incompatibleConditions: []
|
||||
guardrails:
|
||||
- id: guardrail-1
|
||||
severity: blocking
|
||||
text: Keep the template concise enough to be completed consistently.
|
||||
- id: guardrail-2
|
||||
severity: blocking
|
||||
text: Do not require claims that reviewers cannot verify.
|
||||
- id: guardrail-3
|
||||
severity: blocking
|
||||
text: Separate universal checks from risk-specific optional sections.
|
||||
workflow:
|
||||
- id: inspect-workflow
|
||||
title: Inspect contribution flow
|
||||
instruction: Read existing templates, CI checks, review conventions and common failure patterns.
|
||||
required: true
|
||||
- id: design-template
|
||||
title: Design template
|
||||
instruction: Create purpose, scope, testing, risk, screenshots/migrations and reviewer guidance sections.
|
||||
required: true
|
||||
- id: add-checklist
|
||||
title: Add checklist
|
||||
instruction: Include only checks supported by repository policy or requested by the user.
|
||||
required: true
|
||||
- id: place-file
|
||||
title: Place template
|
||||
instruction: Use the correct Gitea-compatible repository path and preserve existing templates.
|
||||
required: true
|
||||
- id: review-usability
|
||||
title: Review usability
|
||||
instruction: Verify the template is clear for small fixes and larger changes without excessive noise.
|
||||
required: true
|
||||
validation:
|
||||
commandRoles:
|
||||
- format-check
|
||||
checks:
|
||||
- id: check-1
|
||||
type: assertion
|
||||
description: The template covers required checks and risk areas without unverifiable boilerplate.
|
||||
blocking: true
|
||||
evidence: Referenced files, command results or explicit review notes.
|
||||
- id: check-2
|
||||
type: assertion
|
||||
description: The file is placed in a Gitea-compatible path and renders as intended.
|
||||
blocking: true
|
||||
evidence: Referenced files, command results or explicit review notes.
|
||||
- id: command-format-check
|
||||
type: command
|
||||
description: Run the resolved format-check command when the repository profile provides it and record the result.
|
||||
blocking: true
|
||||
evidence: Resolved command, exit status and concise result summary.
|
||||
completion:
|
||||
criteria:
|
||||
- Template is concise and repository-specific.
|
||||
- It references real validation commands or roles.
|
||||
- Validation evidence and unresolved limitations are reported honestly.
|
||||
failurePolicy:
|
||||
onValidationFailure: Investigate failures caused by the current work, repair them when they remain within scope, rerun
|
||||
affected validation and report any genuine blocker without claiming success.
|
||||
onAmbiguity: Use repository evidence and existing conventions for minor reversible choices. Preserve current behavior
|
||||
and stop before any material irreversible decision that the specification does not resolve.
|
||||
onMissingContext: Inspect the repository for missing non-sensitive context. Never invent commands, credentials, production
|
||||
behavior or validation results; report what remains unavailable.
|
||||
onOutOfScopeCause: Explain the evidenced out-of-scope cause, avoid unrelated changes and provide the smallest safe follow-up
|
||||
recommendation.
|
||||
onExternalDependencyUnavailable: Use an approved local substitute or fixture only when it preserves the behavior under
|
||||
test. Otherwise record the blocked validation and do not claim the external path succeeded.
|
||||
onUnableToReproduce: Record attempted reproduction, environment and observed evidence. Do not apply speculative production
|
||||
changes; provide the narrowest next diagnostic action.
|
||||
reporting:
|
||||
sections:
|
||||
- id: outcome
|
||||
title: Outcome
|
||||
required: true
|
||||
description: State the delivered result or audit conclusion without overstating evidence.
|
||||
- id: evidence
|
||||
title: Evidence and scope
|
||||
required: true
|
||||
description: List inspected or changed areas and the evidence supporting the result.
|
||||
- id: validation
|
||||
title: Validation
|
||||
required: true
|
||||
description: Report commands, manual checks and their actual outcomes.
|
||||
- id: risks
|
||||
title: Risks and limitations
|
||||
required: true
|
||||
description: State residual risk, inaccessible evidence and untested conditions.
|
||||
- id: follow-up
|
||||
title: Recommended follow-up
|
||||
required: true
|
||||
description: List the smallest useful next actions or state None.
|
||||
template:
|
||||
main: prompt.md
|
||||
partials: []
|
||||
exports:
|
||||
prompt: true
|
||||
markdown: true
|
||||
runPack: false
|
||||
agentsSuggestion: false
|
||||
quality:
|
||||
reviewStatus: editorial-reviewed
|
||||
testedStacks: []
|
||||
knownLimitations:
|
||||
- Repository-specific effectiveness depends on the accuracy of the selected profile and the evidence available to Codex.
|
||||
evaluationCaseIds:
|
||||
- pull-request-template.static-structure
|
||||
Reference in New Issue
Block a user