diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 051b4700f..2d073fbeb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,9 +17,10 @@ ### Checklist -- I have read the [contributors guidelines](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/deepset-ai/haystack/blob/main/code_of_conduct.txt) -- I have updated the related issue with new insights and changes -- I added unit tests and updated the docstrings +- I have read the [contributors guidelines](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/deepset-ai/haystack/blob/main/code_of_conduct.txt). +- I have updated the related issue with new insights and changes. +- I have added unit tests and updated the docstrings. - I've used one of the [conventional commit types](https://www.conventionalcommits.org/en/v1.0.0/) for my PR title: `fix:`, `feat:`, `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:` and added `!` in case the PR includes breaking changes. -- I documented my code -- I ran [pre-commit hooks](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md#installation) and fixed any issue +- I have documented my code. +- I have added a release note file, following the [contributors guidelines](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md#release-notes). +- I have run [pre-commit hooks](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md#installation) and fixed any issue. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c36f05d16..5fca5d943 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -291,6 +291,23 @@ enhancements: Upgrade transformers to the latest version 4.31.0 so that Haystack can support the new LLama2 models. ``` +Each section of the YAML file must follow [reStructuredText formatting](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html). + +For inline code, use double backticks to wrap the code. +``` +``OpenAIChatGenerator`` +``` + +For code blocks, use the [code block directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block). + +``` +.. code:: python + from haystack.dataclasses import ChatMessage + + message = ChatMessage.from_user("Hello!") + print(message.text) +``` + You can now add the file to the same branch containing the code changes. Your release note will be part of your pull request and reviewed along with any code you changed.