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
+37-38Lines changed: 37 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -4,43 +4,6 @@ Contributions are licensed on a license-in/license-out basis.
4
4
5
5
# Contributing Guide
6
6
7
-
## Set up your environment
8
-
9
-
This project uses [Poetry](https://python-poetry.org/) for dependency management, tests, and linting.
10
-
11
-
1. Clone this respository
12
-
2. Run `poetry install`
13
-
14
-
### Unit Tests
15
-
16
-
We use [Pytest](https://docs.pytest.org/en/7.1.x/) as our test runner. Invoke it with `poetry run pytest`, all other arguments are passed directly to `pytest`.
17
-
18
-
#### All tests
19
-
```bash
20
-
poetry run pytest tests
21
-
```
22
-
23
-
#### Only a specific test file
24
-
25
-
```bash
26
-
poetry run pytest tests/tests.py
27
-
```
28
-
29
-
#### Only a specific method
30
-
31
-
```bash
32
-
poetry run pytest tests/tests.py::ClientTestSuite::test_closing_connection_closes_commands
33
-
```
34
-
35
-
### Code formatting
36
-
37
-
This project uses [Black](https://pypi.org/project/black/).
38
-
39
-
```
40
-
poetry run black src
41
-
```
42
-
43
-
44
7
## Communication
45
8
Before starting work on a major feature, please reach out to us via GitHub, Slack, email, etc. We will make sure no one else is already working on it and ask you to open a GitHub issue.
46
9
A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior.
Use your real name (sorry, no pseudonyms or anonymous contributions.)
105
68
```
106
69
107
-
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with git commit -s.
70
+
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with git commit -s.
71
+
72
+
## Set up your environment
73
+
74
+
This project uses [Poetry](https://python-poetry.org/) for dependency management, tests, and linting.
75
+
76
+
1. Clone this respository
77
+
2. Run `poetry install`
78
+
79
+
### Unit Tests
80
+
81
+
We use [Pytest](https://docs.pytest.org/en/7.1.x/) as our test runner. Invoke it with `poetry run pytest`, all other arguments are passed directly to `pytest`.
82
+
83
+
#### All tests
84
+
```bash
85
+
poetry run pytest tests
86
+
```
87
+
88
+
#### Only a specific test file
89
+
90
+
```bash
91
+
poetry run pytest tests/tests.py
92
+
```
93
+
94
+
#### Only a specific method
95
+
96
+
```bash
97
+
poetry run pytest tests/tests.py::ClientTestSuite::test_closing_connection_closes_commands
98
+
```
99
+
100
+
### Code formatting
101
+
102
+
This project uses [Black](https://pypi.org/project/black/).
0 commit comments