Get Started!¶

Ready to contribute?

Local setup¶

Here’s how to set up rbd-iscsi-client for local development.

Clone the rbd-iscsi-client git repository:

$ git clone https://opendev.org/openstack/rbd-iscsi-client.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your repo for local development:
```
$ mkvirtualenv rbd-iscsi-client
$ cd rbd-iscsi-client/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ tox -e pep8
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push them to the opendev gerrit. (Please follow the OpenStack standard for commit messages. If you haven’t already, you’ll need to install the git-review package from your operating system distro first):
```
$ git add .
$ git commit
$ git review
```

Before you submit a patch, check that it meets these guidelines:

The patch should include tests.
If the patch adds functionality, the docs should be updated. Put your new functionality into a function with a docstring and add a release note to your patch.
The patch should work for at least Python 3.6 and 3.8.

To run a subset of tests:

$ tox -epy38 tests.test_rbd_iscsi_client