Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Commit ba223d1

Browse files
committed
Update CONTRIBUTING.md
1 parent 871016d commit ba223d1

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Contributions are very welcome! We'll be happy to help you in the process.
44

55
## What should I know before I get started?
66

7-
Go through the README and the documentation, and make sure that you understand how data-diff works.
7+
Go through the README and the documentation, and make sure that you understand how data-diff works.
88

99
## How to contribute?
1010

@@ -13,12 +13,12 @@ Go through the README and the documentation, and make sure that you understand h
1313
Please report the bug with as many details as you can.
1414

1515
1. Include the exact command that you used. Make sure to run data-diff with the `-d` flag for debug output.
16-
2. Provide the entire output of the command. (stdout, logs, exception)
16+
2. Provide the entire output of the command. (stdout, logs, exception)
1717
3. If possible, show us how we could reproduce the bug. i.e. how to set up an environment in which it occurs.
1818

1919
(When pasting, always make sure to redact sensitive information, like passwords.)
2020

21-
If data-diff returns incorrect results, i.e. false-positive or false-negative, please also include the original values.
21+
If data-diff returns incorrect results, i.e. false-positive or false-negative, please also include the original values.
2222

2323
Before you report a bug, make sure it doesn't already exist.
2424

@@ -66,7 +66,7 @@ Make sure to update the appropriate `TEST_*_CONN_STRING`, so that it will be inc
6666

6767
You can run the tests with `unittest`.
6868

69-
When running against multiple databases, the tests can take a long while.
69+
When running against multiple databases, the tests can take a long while.
7070

7171
To save time, we recommend running them with `unittest-parallel`.
7272

@@ -76,6 +76,6 @@ When debugging, we recommend using the `-f` flag, to stop on error. Also, use th
7676

7777
New databases should be added as a new module in the `data-diff/databases/` folder.
7878

79-
Make sure to update the `DATABASE_TYPES` dictionary in `tests/test_database_types.py`, so that it will be included in the tests.
80-
8179
If possible, please also add the database setup to `docker-compose.yml`, so that we can run and test it for ourselves. If you do, also update the CI (`ci.yml`).
80+
81+
Guide to implementing a new database driver: https://data-diff.readthedocs.io/en/latest/new-database-driver-guide.html

0 commit comments

Comments
 (0)