mirror of
https://github.com/deepset-ai/haystack.git
synced 2026-01-01 01:27:28 +00:00
6cbd1857d1
* chore: add info on reStructuredText to contributing guidelines for release notes * refine
27 lines
1.3 KiB
Markdown
27 lines
1.3 KiB
Markdown
### Related Issues
|
|
|
|
- fixes #issue-number
|
|
|
|
### Proposed Changes:
|
|
|
|
<!--- In case of a bug: Describe what caused the issue and how you solved it -->
|
|
<!--- In case of a feature: Describe what did you add and how it works -->
|
|
|
|
### How did you test it?
|
|
|
|
<!-- unit tests, integration tests, manual verification, instructions for manual tests -->
|
|
|
|
### Notes for the reviewer
|
|
|
|
<!-- E.g. point out section where the reviewer -->
|
|
|
|
### 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 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 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.
|