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
Before you start working on development, please install the necessary dependencies for Dubbo-Python using the following command:
66
+
67
+
```shell
68
+
pip install -r requirements-dev.txt
69
+
```
70
+
71
+
Our project uses a `src` layout, and packaging is required before running tests. We strongly recommend using the **editable installation mode** for packaging and testing:
72
+
73
+
```shell
74
+
pip install -e .
75
+
```
76
+
77
+
78
+
61
79
### Code style
62
80
63
81
We use **ruff** as the linter and code formatter for Dubbo-Python, and **Mypy** as the static type checker.
@@ -73,7 +91,7 @@ We have already set up the configurations for ruff and Mypy in the `pyproject.to
73
91
74
92
By default, ruff will look for the `pyproject.toml` file in the current directory and its parent directories and load its configuration.
75
93
76
-
```bash
94
+
```shell
77
95
# Default
78
96
ruff format
79
97
@@ -83,7 +101,7 @@ We have already set up the configurations for ruff and Mypy in the `pyproject.to
83
101
84
102
2. Code Linting
85
103
86
-
```bash
104
+
```shell
87
105
# Just check
88
106
ruff check
89
107
@@ -95,7 +113,7 @@ We have already set up the configurations for ruff and Mypy in the `pyproject.to
95
113
96
114
Mypy will also automatically look for the `pyproject.toml` file and load its configuration.
Get up and running with Dubbo-Python in just 5 minutes by following our [Quick Start Guide](https://github.com/apache/dubbo-python/tree/main/samples).
@@ -116,7 +119,11 @@ It's as simple as the code snippet below. With just a few lines of code, you can
116
119
117
120
```
118
121
119
-
122
+
## Contributing
123
+
124
+
We are excited to welcome contributions to the Dubbo-Python project! Whether you are fixing bugs, adding new features, or improving documentation, your input is highly valued.
125
+
126
+
To ensure a smooth collaboration, please review our [Contributing Guide](https://github.com/apache/dubbo-python/blob/main/CONTRIBUTING.md) for detailed instructions on how to get started, adhere to coding standards, and submit your contributions effectively.
0 commit comments