You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 17, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Contributions are very welcome! We'll be happy to help you in the process.
4
4
5
5
## What should I know before I get started?
6
6
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.
8
8
9
9
## How to contribute?
10
10
@@ -13,12 +13,12 @@ Go through the README and the documentation, and make sure that you understand h
13
13
Please report the bug with as many details as you can.
14
14
15
15
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)
17
17
3. If possible, show us how we could reproduce the bug. i.e. how to set up an environment in which it occurs.
18
18
19
19
(When pasting, always make sure to redact sensitive information, like passwords.)
20
20
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.
22
22
23
23
Before you report a bug, make sure it doesn't already exist.
24
24
@@ -66,7 +66,7 @@ Make sure to update the appropriate `TEST_*_CONN_STRING`, so that it will be inc
66
66
67
67
You can run the tests with `unittest`.
68
68
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.
70
70
71
71
To save time, we recommend running them with `unittest-parallel`.
72
72
@@ -76,6 +76,6 @@ When debugging, we recommend using the `-f` flag, to stop on error. Also, use th
76
76
77
77
New databases should be added as a new module in the `data-diff/databases/` folder.
78
78
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
-
81
79
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