Update CONTRIBUTING.md

This commit is contained in:
Malte Pietsch 2021-10-18 09:14:03 +02:00 committed by GitHub
parent 655d721371
commit 3a4b3cd59d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,9 +3,9 @@
We are very open to community contributions and appreciate anything that improves `haystack`! This includes fixings typos, adding missing documentation, fixing bugs or adding new features.
To avoid unnecessary work on either side, please stick to the following process:
1. Check if there is already [an related issue](https://github.com/deepset-ai/haystack/issues).
2. If there is not, open a new one to start a discussion. Some features might be a nice idea, but don't fit in the scope of Haystack and we hate to close finished PRs!
3. If we came to the conclusion to move forward with your issue, we will be happy to accept a pull request. Make sure you create a pull request in an early draft version and ask for feedback.
1. Check if there is already [a related issue](https://github.com/deepset-ai/haystack/issues).
2. Open a new issue to start a quick discussion. Some features might be a nice idea, but don't fit in the scope of Haystack and we hate to close finished PRs!
3. Create a pull request in an early draft version and ask for feedback. If this is your first pull request and you wonder how to actually create a pull request, checkout [this manual](https://opensource.com/article/19/7/create-pull-request-github).
4. Verify that all tests in the CI pass (and add new ones if you implement anything new)
## Formatting of Pull Requests