Require an assigned issue before accepting new-tutorial PRs - #490
Open
kacperlukawski wants to merge 1 commit into
Open
kacperlukawski wants to merge 1 commit into
kacperlukawski wants to merge 1 commit into
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
pull_request_targetworkflow 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.CONTRIBUTING.md/README.mdto point at the new process.AGENTS.mdso AI coding agents follow the same process and repo conventions (naming convention,index.tomlregistration,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
Closes #<issue>where the issue isn't assigned to the author and confirm it's rejected.Closes #<issue>where the issue is assigned to the author and confirm it passes.🤖 Generated with Claude Code