Skip to content

Require an approved proposal issue before new integration PRs - #748

Open
kacperlukawski wants to merge 1 commit into
mainfrom
proof-of-use-issue-first
Open

kacperlukawski wants to merge 1 commit into
mainfrom
proof-of-use-issue-first

Conversation

@kacperlukawski

Copy link
Copy Markdown
Member

Summary

  • Adds an issue form (.github/ISSUE_TEMPLATE/new-integration.yml) for proposing a new integration, or just discussing whether one's needed, before a PR is opened
  • Adds a PR template that expects the PR to link that issue (Closes #123)
  • Adds a status check (.github/workflows/require-approved-issue.yml) that fails the PR unless its body links an issue labeled approved
  • Updates the README contribution section to describe the new flow

This does not restrict who can open a PR — any contributor, org member or not, can still open one. It only gates merging: the check fails until the linked issue is labeled approved.

Enabling enforcement

The workflow runs and reports a status on every PR, but nothing blocks merge until it's marked required. To enable:

  1. Go to Settings → Branches in this repo
  2. Edit (or add) the branch protection rule for main
  3. Under Require status checks to pass before merging, enable it and add the check job from the Require approved issue workflow
  4. Save

Once that's set, PRs without a linked approved issue can't be merged, though they can still be opened and discussed.

Test plan

  • Open a test PR without a linked issue — confirm the check fails
  • Open an issue via the new template, label it approved, open a PR with Closes #<that issue> — confirm the check passes
  • After enabling the required status check, confirm an unapproved PR is blocked from merging in the GitHub UI

🤖 Generated with Claude Code

Adds an issue form so contributors can either discuss the need for an
integration or propose one that already exists, a PR template that
links back to it, and a status check that fails unless the PR body
links an issue labeled approved.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@kacperlukawski
kacperlukawski requested a review from a team as a code owner November 19, 2026 14:02
@vercel

vercel Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
haystack-integrations Ready Ready Preview Nov 19, 2026 2:03pm UTC

Request Review

@kacperlukawski

Copy link
Copy Markdown
Member Author

@bilgeyucel This is an idea how to change the workflow in that repository, so each contribution starts with an issue. Let's discuss that next week.

This branch was successfully deployed

1 active deployment
Preview — f96ee285 Deployed Nov 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant