Open
Conversation
* Add a TLDR for first PR * Fix the broken link * Some grammer fixes * Add high quality contributions section * Add info about using AI assistants * Add info about issues to be handled internally
bilgeyucel
added
the
ignore-for-release-notes
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
bogdankostic
reviewed
Mar 9, 2026
Contributor
bogdankostic
left a comment
bogdankostic
left a comment
There was a problem hiding this comment.
Nice! I especially like the high-level to-do list. Just left a few language-related comments.
|
|
||
| If you then still feel the need to ask a question and need clarification, you can use one of our | ||
| [Community Channels](https://haystack.deepset.ai/community), Discord, in particular, is often very helpful. | ||
| If you then still feel the need to ask a question and need clarification, you can use [Haystack Discord Server](https://discord.com/invite/xYvH6drSmA) |
Contributor
There was a problem hiding this comment.
Suggested change
| If you then still feel the need to ask a question and need clarification, you can use [Haystack Discord Server](https://discord.com/invite/xYvH6drSmA) | |
| If you then still feel the need to ask a question and need clarification, you can use [Haystack's Discord Server](https://discord.com/invite/xYvH6drSmA). |
| - **Documentation** — If your change adds or alters user-facing behavior, add a new docs page or update the relevant one in `docs-website/` (edit under `docs/` for the next release; add new pages to `sidebars.js`). See the [Documentation Contributing Guide](docs-website/CONTRIBUTING.md) for where to edit, frontmatter, and navigation. | ||
| - **Release notes** — Add a release note under `releasenotes/notes` with `hatch run release-note your-change-name` (see [Release notes](#release-notes)); maintainers can add `ignore-for-release-notes` for tests-only or CI-only changes. | ||
| - **Open the PR** — Use a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) title, fill the [PR template](.github/pull_request_template.md), and if the PR was fully AI-generated, add a [short disclaimer](#using-ai-assistants-to-contribute). Enable "Allow edits and access to secrets by maintainers" on the PR. | ||
| - **Before submitting** — Fix any [CI](#ci-continuous-integration) failures and address review feedback. |
Contributor
There was a problem hiding this comment.
Technically the PR is already submitted, so I'd propose the following wording:
Suggested change
| - **Before submitting** — Fix any [CI](#ci-continuous-integration) failures and address review feedback. | |
| - **Once the PR is open** — Fix any [CI](#ci-continuous-integration) failures and address review feedback. |
Comment on lines
+115
to
+116
| - If the team is able to reproduce the issue, the issue will be scheduled for a fix or left to be | ||
| [implemented by someone](https://github.com/deepset-ai/haystack/issues?q=is%3Aissue%20state%3Aopen%20label%3A"Contributions%20wanted!"). |
Contributor
There was a problem hiding this comment.
Suggested change
| - If the team is able to reproduce the issue, the issue will be scheduled for a fix or left to be | |
| [implemented by someone](https://github.com/deepset-ai/haystack/issues?q=is%3Aissue%20state%3Aopen%20label%3A"Contributions%20wanted!"). | |
| - If the team is able to reproduce it, the issue will be scheduled for a fix or left to be | |
| [picked up by a community contributor](https://github.com/deepset-ai/haystack/issues?q=is%3Aissue%20state%3Aopen%20label%3A"Contributions%20wanted!"). |
| @@ -116,7 +126,7 @@ find related suggestions. | |||
| - Make sure that you are using the latest version. | |||
| - Read the [documentation](https://docs.haystack.deepset.ai/docs/intro) carefully and find out if the functionality | |||
| is already covered, maybe by an individual configuration. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| is already covered, maybe by an individual configuration. | |
| is already covered, possibly via particular configuration parameters. |
| > [!IMPORTANT] | ||
| > When contributing to this project, you must agree that you have authored 100% of the content, that you have the | ||
| > necessary rights to the content and that the content you contribute may be provided under the project license. | ||
| > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. |
Contributor
There was a problem hiding this comment.
Given that further below we allow the usage of AI assistants, maybe we should rephrase this to something along the following: you have authored or carefully reviewed 100% of the content
| limited in scope, easily fixable and low priority, so there is absolutely no reason why you should not try fixing them, | ||
| it's a good excuse to start looking into the project and a safe space for experimenting failure: if you don't get the | ||
| limited in scope, easily fixable and low priority, so there is absolutely no reason why you should not try fixing them. | ||
| It's a good excuse to start looking into the project and a safe space for experimenting failure: if you don't get the |
Contributor
There was a problem hiding this comment.
Suggested change
| It's a good excuse to start looking into the project and a safe space for experimenting failure: if you don't get the | |
| It's a good excuse to start looking into the project and a safe space to experiment and fail: if you don't get the |
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
2 participants
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.
Proposed Changes:
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.