Skip to content

Require an assigned issue before accepting new-tutorial PRs - #490

Open
kacperlukawski wants to merge 1 commit into
mainfrom
require-issue-before-pr
Open

kacperlukawski wants to merge 1 commit into
mainfrom
require-issue-before-pr

Conversation

@kacperlukawski

Copy link
Copy Markdown
Member

Summary

  • New tutorials now require an issue (via a structured template) filed and assigned by a maintainer before a PR is accepted — closes the door on drive-by PRs that promote a third-party tool rather than a Haystack use case.
  • A pull_request_target workflow auto-closes PRs that add a new tutorial without referencing an issue (Closes #N) assigned to the PR's author. Edits/fixes to existing tutorials are not gated.
  • Added new-tutorial issue template (form), disabled blank issues, added a PR template, and updated CONTRIBUTING.md/README.md to point at the new process.
  • Added AGENTS.md so AI coding agents follow the same process and repo conventions (naming convention, index.toml registration, template.ipynb) before generating a PR.

Reference: same policy as deepset-ai/haystack-cookbook#316, adapted to this repo's structure (tutorials/, index.toml, template.ipynb) and scoped so only new-tutorial PRs are gated.

Test plan

  • Open a test PR that adds a new tutorial without a linked issue against a fork/branch and confirm the workflow comments + closes it.
  • Open a test PR with Closes #<issue> where the issue isn't assigned to the author and confirm it's rejected.
  • Open a test PR with Closes #<issue> where the issue is assigned to the author and confirm it passes.
  • Open a test PR that only edits an existing tutorial and confirm it is NOT gated.
  • Confirm the new issue template renders correctly and blank issues are disabled.

🤖 Generated with Claude Code

Drive-by PRs pitching third-party tools rather than genuine Haystack
use cases have been getting through since the process was just "open
a PR". Now contributors must file a new-tutorial issue via a
structured template, get it assigned by a maintainer, and reference
it in their PR; a workflow auto-closes new-tutorial PRs that skip
this. Edits and fixes to existing tutorials are unaffected.

Also adds AGENTS.md so AI coding agents follow the same process
before generating a PR.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@kacperlukawski
kacperlukawski requested a review from a team as a code owner September 16, 2026 15:40
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