Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.96 KB

CONTRIBUTING.rst

File metadata and controls

60 lines (40 loc) · 1.96 KB
Raw

Contributing to PostgreSQL Anonymizer

First of all: thanks for your interest in this project and taking the time to contribute.

The following document is a small set of guidelines for contributing to this project. They are guidelines and no rules.

Reporting bugs

If you have found a bug, please check the project's issue page first and feel free to create a new issue, if no one else has reported it yet.

Making changes

Create a fork if you want to make changes or clone the repo if you want a readonly access to the current development version:

$ git clone [email protected]:rheinwerk-verlag/postgresql-anonymizer.git
$ cd postgresql-anonymizer

We are using poetry for development, you may need to install it first:

$ sudo pip install poetry

Now you can install all development requirements and activate the virtualenv:

$ poetry install
$ poetry shell

Coding style

We have created an EditorConfig file for this project that should be usable for most IDEs. Otherwise please make sure to adhere to the specifications from the config file.

Creating a pull request

Before creating a pull request make sure to check:

  • existing docstrings have been updated
  • new code has valid docstrings
  • whether existing tests have to be fixed
  • new tests have to be written first
  • the documentation (in particular the Sphinx documentation) has to be modified