Skip to content

Latest commit

 

History

History
382 lines (287 loc) · 18 KB

CONTRIBUTING.md

File metadata and controls

382 lines (287 loc) · 18 KB
Raw

Contributing to Haystack

First off, thanks for taking the time to contribute! 💙

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions!

Tip

If you like Haystack but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star this repository
  • Tweet about it
  • Mention Haystack at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to haystack@deepset.ai.

I Have a Question

Tip

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, you can use one of our Community Channels, Discord, in particular, is often very helpful.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information, and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side, for example using incompatible versions. Make sure that you have read the documentation. If you are looking for support, you might want to check this section.
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of Haystack and the integrations you're using
    • Possibly your input and the output
    • If you can reliably reproduce the issue, a snippet of code we can use

How Do I Submit a Good Bug Report?

Important

You must never report security-related issues, vulnerabilities, or bugs, including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be reported using this link.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue of type Bug Report.
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports, you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps.
  • If the team is able to reproduce the issue, the issue will scheduled for a fix or left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including new integrations and improvements to existing ones. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing and distributing the integration on your own.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues of type Feature request for existing integrations.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Fill the issue following the template

Contribute code

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.

Where to start

If this is your first contribution, a good starting point is looking for an open issue that's marked with the label "good first issue". The core contributors periodically mark certain issues as good for first-time contributors. Those issues are usually 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 grasp of something, pick another one! Once you become comfortable contributing to Haystack, you can have a look at the list of issues marked as contributions wanted to look for your next contribution!

Setting up your development environment

Haystack makes heavy use of Hatch, a Python project manager that we use to set up the virtual environments, build the project, and publish packages. As you can imagine, the first step towards becoming a Haystack contributor is installing Hatch. There are a variety of installation methods depending on your operating system platform, version, and personal taste: please have a look at this page and keep reading once you can run from your terminal:

$ hatch --version
Hatch, version 1.9.3

You can create a new virtual environment for Haystack with hatch by running:

$ hatch shell

Clone the git repository

You won't be able to make changes directly to this repo, so the first step is to create a fork. Once your fork is ready, you can clone a local copy with:

$ git clone https://github.com/YOUR-USERNAME/haystack

If everything worked, you should be able to do something like this (the output might be different):

$ cd haystack
$ hatch version
2.3.0-rc0

Last, install the pre-commit hooks with:

pre-commit install

This utility will run some tasks right before all git commit operations. From now on, your git commit output for Haystack should look something like this:

> git commit -m "test"
check python ast.........................................................Passed
check json...........................................(no files to check)Skipped
check for merge conflicts................................................Passed
check that scripts with shebangs are executable..........................Passed
check toml...........................................(no files to check)Skipped
check yaml...........................................(no files to check)Skipped
fix end of files.........................................................Passed
mixed line ending........................................................Passed
don't commit to branch...................................................Passed
trim trailing whitespace.................................................Passed
ruff.....................................................................Passed
codespell................................................................Passed
Lint GitHub Actions workflow files...................(no files to check)Skipped
[massi/contrib d18a2577] test
 2 files changed, 178 insertions(+), 45 deletions(-)

Run the tests locally

Tests will automatically run in our CI for every commit you push to your PR on Github. In order to save precious CI time we encourage you to run the tests locally before pushing new commits to Github. From the root of the git repository, you can run all the unit tests like this:

hatch run test:unit

Hatch will create a dedicated virtual environment, sync the required dependencies and run all the unit tests from the project. If you want to run a subset of the tests or even one test in particular, hatch will accept all the options you would normally pass to pytest, for example:

# run one test method from a specific test class in a test file
hatch run test:unit test/test_logging.py::TestSkipLoggingConfiguration::test_skip_logging_configuration

Run code quality checks locally

We also use tools to ensure consistent code style, quality, and static type checking. The quality of your code will be tested by the CI, but once again, running the checks locally will speed up the review cycle.

To check your code type checking, run:

hatch run test:types

To check your code format run:

hatch run format-check

To format your code, you can run:

hatch run format

To check your code style according to linting rules run:

hatch run check
hatch run test:lint

If the linters spot any error, you can fix it before checking in your code:

hatch run fix

Requirements for Pull Requests

To ease the review process, please follow the instructions in this paragraph when creating a Pull Request:

Release notes

Each PR must include a release notes file under the releasenotes/notes path created with reno, and a CI check will fail if that's not the case. Pull requests with changes limited to tests, code comments or docstrings, and changes to the CI/CD systems can be labeled with ignore-for-release-notes by a maintainer in order to bypass the CI check.

For example, if your PR is bumping the transformers version in the pyproject.toml file, that's something that requires release notes. To create the corresponding file, from the root of the repo run:

$ hatch run release-note bump-transformers-to-4-31

A release notes file in YAML format will be created in the appropriate folder, appending a unique id to the name of the release note you provided (in this case, bump-transformers-to-4-31). To add the actual content of the release notes, you must edit the file that's just been created. In the file, you will find multiple sections along with an explanation of what they're for. You have to remove all the sections that don't fit your release notes, in this case for example you would fill in the enhancements section to describe the change:

enhancements:
  - |
    Upgrade transformers to the latest version 4.31.0 so that Haystack can support the new LLama2 models.

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.

CI (Continuous Integration)

We use GitHub Action for our Continuous Integration tasks. This means that as soon as you open a PR, GitHub will start executing some workflows on your changes, like automated tests, linting, formatting, api docs generation, etc.

If all goes well, at the bottom of your PR page you should see something like this, where all checks are green.

Successful CI

If you see some red checks (like the following), then something didn't work, and action is needed from your side.

Failed CI

Click on the failing test and see if there are instructions at the end of the logs of the failed test. For example, in the case above, the CI will give you instructions on how to fix the issue.

Logs of failed CI, with instructions for fixing the failure

Working from GitHub forks

In order for maintainers to be able to help you, we usually ask contributors to give us push access to their fork.

To do so, please verify that "Allow edits and access to secrets by maintainers" on the PR preview page is checked (you can check it later on the PR's sidebar once it's created).

Allow access to your branch to maintainers

Writing tests

We formally define three scopes for tests in Haystack with different requirements and purposes:

Unit test

  • Tests a single logical concept
  • Execution time is a few milliseconds
  • Any external resource is mocked
  • Always returns the same result
  • Can run in any order
  • Runs at every commit in PRs, automated through hatch run test:unit
  • Can run locally with no additional setup
  • Goal: being confident in merging code

Integration test

  • Tests a single logical concept
  • Execution time is a few seconds
  • It uses external resources that must be available before execution
  • When using models, cannot use inference
  • Always returns the same result or an error
  • Can run in any order
  • Runs at every commit in PRs, automated through hatch run test:integration
  • Can run locally with some additional setup (e.g. Docker)
  • Goal: being confident in merging code

End to End (e2e) test

  • Tests a sequence of multiple logical concepts
  • Execution time has no limits (can be always on)
  • Can use inference
  • Evaluates the results of the execution or the status of the system
  • It uses external resources that must be available before execution
  • Can return different results
  • Can be dependent on the order
  • Can be wrapped into any process execution
  • Runs outside the development cycle (nightly or on demand)
  • Might not be possible to run locally due to system and hardware requirements
  • Goal: being confident in releasing Haystack

Contributor Licence Agreement (CLA)

Significant contributions to Haystack require a Contributor License Agreement (CLA). If the contribution requires a CLA, we will get in contact with you. CLAs are quite common among company-backed open-source frameworks, and our CLA’s wording is similar to other popular projects, like Rasa or Google's Tensorflow (retrieved 4th November 2021).

The agreement's main purpose is to protect the continued open use of Haystack. At the same time, it also helps in \protecting you as a contributor. Contributions under this agreement will ensure that your code will continue to be open to everyone in the future (“You hereby grant to Deepset and anyone [...]”) as well as remove liabilities on your end (“you provide your Contributions on an AS IS basis, without warranties or conditions of any kind [...]”). You can find the Contributor Licence Agreement here.

If you have further questions about the licensing, feel free to reach out to contributors@deepset.ai.