Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (52 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

78 lines (52 loc) · 1.91 KB

Contributing to Rossum SDK for Python

We welcome contributions to rossum-sdk by the community. If you are building an integration, see the Developer Docs page.

Submitting changes

  • Use pre-commit to avoid linting issues.
  • Submit a pull request from forked version of this repo, referencing any issues it addresses.
  • Add tests for your changes to tests/.
  • Add proper docstrings and update Sphinx documentation if applicable.
  • Run tests and make sure all of them pass.
  • Select any of the maintainers as a reviewer.
  • After an approved review, when releasing, a Collaborator with Admin role shall do the following in master branch:
    • Update the Changelog, describing all the changes included in the newest release
    • Release a new version

We will review your pull request as soon as possible. Thank you for contributing!

Development environment

Clone the repo

git clone git@github.com:rossumai/rossum-sdk.git

Make sure that you have Python 3 installed. Version 3.10 or higher is required to run style checkers on pre-commit. On macOS, we recommend using brew to install Python. For Windows, we recommend an official python.org release.

Create a virtual environment

cd rossum-sdk

python -m venv .env

source .env/bin/activate

Install rossum-sdk in editable mode

pip install -e .

Install coding style pre-commit hooks

This will make sure that your commits will have the correct coding style.

pre-commit install

pre-commit install-hooks

That's it. You should be ready to make changes, run tests, and make commits!

Running tests

cd rossum-sdk

# create virtual environment
python -m venv .env

# activate virtual environment
source .env/bin/activate

# install sentry-python
pip install -e .

# install requirements
pip install -e ."[tests]"

# run tests
pytest tests/