Skip to content

Define design-doc expectations for deep, high-risk PRs #443

Description

@enyst

Desired Behavior

The automation repository's code-review guide should ask for a concise design doc when a deep, high-risk scheduling, webhook, or dispatch change cannot be evaluated efficiently from the diff, while avoiding unnecessary documentation for small or self-explanatory changes.

The policy must also account for .pr/ cleanup: an automated approval must not remove the only design artifact before a human maintainer has had the opportunity to review it.

Acceptance Criteria

  • Deep, high-risk PRs without adequate design context do not receive automated approval.
  • Low-risk, trivial, generated, or self-explanatory changes are not blocked solely by design-doc absence or line count.
  • An equivalent PR-description write-up has clear minimum content: intent, important before/after behavior or API shape, compatibility/risk, and grounded code references.
  • A .pr/ design doc remains available through the human review decision, or equivalent persistent context is present in the PR description before automated approval triggers cleanup.
  • The guidance remains consistent with the repository's required approval gate.

This issue was created by an AI agent (OpenHands) on behalf of @enyst.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestready-for-devScoped for contribution; managed by repository readiness checks.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions