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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+45-13Lines changed: 45 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ The development requirements are listed in the `requirements-devel.txt` file. In
6
6
pip install -r requirements-devel.txt
7
7
```
8
8
9
-
The newest client versions sometimes require upcoming Weaviate core features. We recommend using Docker (see https://docs.weaviate.io/deploy/installation-guides/docker-installation) to run a local instance of the `latest Weaviate core <https://hub.docker.com/r/semitechnologies/weaviate/tags>`_ for client development.
9
+
The newest client versions sometimes require upcoming Weaviate core features. We recommend using Docker (see https://docs.weaviate.io/deploy/installation-guides/docker-installation) to run a local instance of the [latest Weaviate core](https://hub.docker.com/r/semitechnologies/weaviate/tags) for client development.
The client is organized around the v4 collections API. When adding or updating code, prefer the existing v4-style collection interfaces rather than the legacy v3 client patterns.
37
+
38
+
Commonly changed areas include:
39
+
40
+
-`weaviate/collections/` for the v4 collection APIs and typed request/response classes.
41
+
-`weaviate/connect/` for connection and transport behavior.
42
+
-`test/` for unit tests that do not require a running Weaviate instance.
43
+
-`mock_tests/` for tests that simulate Weaviate responses.
44
+
-`integration/` for tests that require a local Weaviate instance.
45
+
34
46
### Testing
35
47
36
48
To set up the testing environment, install the test requirements with:
0 commit comments