@@ -7,23 +7,28 @@ Thank you for your interest in contributing to RushDB! To ensure a smooth contri
7
7
When reporting an issue, include the following information:
8
8
9
9
1 . ** Minimum Reproducible Data Set**
10
- - Provide a small JSON or CSV dataset if the issue is related to the core, dashboard, or SDK.
11
- - Ensure the dataset highlights the problem clearly.
10
+
11
+ - Provide a small JSON or CSV dataset if the issue is related to the core, dashboard, or SDK.
12
+ - Ensure the dataset highlights the problem clearly.
12
13
13
14
2 . ** RushDB Version**
14
- - Specify the version of RushDB you are using:
15
- - ** Cloud** : Mention if you are using the latest cloud version.
16
- - ** Self-hosted** : Provide the tag from Docker Hub or the SDK version.
15
+
16
+ - Specify the version of RushDB you are using:
17
+ - ** Cloud** : Mention if you are using the latest cloud version.
18
+ - ** Self-hosted** : Provide the tag from Docker Hub or the SDK version.
17
19
18
20
3 . ** Steps to Reproduce**
19
- - Give a detailed explanation of how to reproduce the issue.
20
- - Include any configurations, commands, or environment settings.
21
+
22
+ - Give a detailed explanation of how to reproduce the issue.
23
+ - Include any configurations, commands, or environment settings.
21
24
22
25
4 . ** Query Examples**
23
- - If applicable, include specific queries that trigger the error.
26
+
27
+ - If applicable, include specific queries that trigger the error.
24
28
25
29
5 . ** Minimum Repository (if SDK-related)**
26
- - For issues related to the SDK, a minimal GitHub repository demonstrating the bug may be required.
30
+
31
+ - For issues related to the SDK, a minimal GitHub repository demonstrating the bug may be required.
27
32
28
33
## Submitting Changes
29
34
@@ -42,21 +47,41 @@ For urgent issues or further assistance, you can reach out directly:
42
47
43
48
We appreciate your contributions and look forward to your feedback!
44
49
45
- ---
46
- ## Poetry commands
50
+ ---
47
51
52
+ ## Development Commands
53
+
54
+ ``` bash
55
+ # Install dependencies
56
+ uv sync --dev
48
57
```
49
- poetry run isort . --check
58
+
59
+ ``` bash
60
+ # Check import sorting
61
+ uv run isort . --check
50
62
```
51
63
64
+ ``` bash
65
+ # Type checking
66
+ uv run mypy src/rushdb
52
67
```
53
- poetry run mypy src/rushdb
68
+
69
+ ``` bash
70
+ # Code formatting
71
+ uv run black .
54
72
```
55
73
74
+ ``` bash
75
+ # Linting
76
+ uv run ruff check .
56
77
```
57
- poetry run black .
78
+
79
+ ``` bash
80
+ # Run tests
81
+ uv run pytest
58
82
```
59
83
84
+ ``` bash
85
+ # Run tests with coverage
86
+ uv run pytest --cov
60
87
```
61
- poetry run ruff check .
62
- ```
0 commit comments