Skip to content

Commit 24390fe

Browse files
committed
Reorganise CONTRIBUTING.md
Signed-off-by: Jesse Whitehouse <[email protected]>
1 parent 2584d48 commit 24390fe

File tree

1 file changed

+37
-38
lines changed

1 file changed

+37
-38
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,6 @@ Contributions are licensed on a license-in/license-out basis.
44

55
# Contributing Guide
66

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-
447
## Communication
458
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.
469
A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior.
@@ -104,4 +67,40 @@ Signed-off-by: Joe Smith <[email protected]>
10467
Use your real name (sorry, no pseudonyms or anonymous contributions.)
10568
```
10669

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/).
103+
104+
```
105+
poetry run black src
106+
```

0 commit comments

Comments
 (0)