Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.6 KB

Contributing to bdi-kit

There are many ways to contribute to bdi-kit, such as improving the codebase, reporting issues or bugs, enhancing the documentation, reviewing pull requests from other developers, adding new matching methods, or expanding support for additional standards. See the instructions below to get started!

Formatting the Code

We format code using the black code formatter. The CI runs for every pull request and will fail if code is not properly formatted. To make sure formatting is correct, you can do the following steps.

Make sure you have black installed:

pip install black

To format the code, anyone can use the command before committing your changes:

make format

Or you can use the black command directly:

black ./bdikit/

Adding New Matching Methods

Contributors can add new methods for schema and value matching by following these steps:

  1. Create a Python module inside the "task folder" folder (e.g., bdikit/value_matching).

  2. Define a class in the module that implements either BaseValueMatcher (for value matching) or BaseSchemaMatcher (for schema matching).

  3. Add a new entry in matcher_factory.py (e.g., bdikit/value_matching/matcher_factory.py). Make sure to add the correct import path for your module to ensure it can be accessed without errors.

Code of Conduct

We abide by the principles of openness, respect, and consideration of others of the Python Software Foundation: https://www.python.org/psf/codeofconduct/.