Skip to content

Commit 11f9fec

Browse files
committed
Simplifying the contributing file
1 parent 2a3002d commit 11f9fec

File tree

1 file changed

+1
-60
lines changed

1 file changed

+1
-60
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -45,32 +45,7 @@ This creates the directory async-search-client and connects your repository to t
4545

4646
Note: This project uses Poetry to manage dependencies. If you do not already have Poetry installed you will need to install it with the instuctions [here](https://python-poetry.org/docs/#installation)
4747

48-
Once you have cloned your fork of the repository you can create a virtual environment. When using Poetry the step is optional.
49-
If you create a virtual environment Poetry will use the environment you have activated, or Poetry will create
50-
and use it's own if you don't create one. If you want to create your own, once you are in the async-search-client directory create and activate
51-
the virtual environment. This step is slightly different for Mac/Linux and Windows.
52-
53-
Mac/Linux
54-
55-
```sh
56-
# Create the environment
57-
python3 -m venv venv
58-
59-
# Activate the environment
60-
. venv/bin/activate
61-
```
62-
63-
Windows
64-
65-
```powershell
66-
# Create the environment
67-
python -m venv venv
68-
69-
#Activate the environment. Use activate.bat for cmd.exe
70-
venv\Scripts\Activate.ps1
71-
```
72-
73-
Next the requirements need to be installed.
48+
First the requirements need to be installed.
7449

7550
```sh
7651
poetry install
@@ -104,22 +79,6 @@ async-search-client uses [isort](https://pycqa.github.io/isort/),
10479

10580
You can run linting on your code at any time with:
10681

107-
```sh
108-
# Run isort
109-
isort async_search_client tests
110-
111-
# Run black
112-
black async_search_client tests
113-
114-
# Run flake8
115-
flake8 async_search_client test
116-
117-
# Run mypy
118-
mypy async_search_client
119-
```
120-
121-
* Note if you did not create your own virtual environment and are using the Poetry environment instead you will need to append `poetry run ...` to each command.
122-
12382
```sh
12483
# Run isort
12584
poetry run isort async_search_client tests
@@ -190,24 +149,12 @@ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=m
190149

191150
Now with the container running run the test suite
192151

193-
```sh
194-
pytest
195-
```
196-
197-
Or if you are using Poetry's virtual environment
198-
199152
```sh
200153
poetry run pytest
201154
```
202155

203156
If you want to see which lines are missing code coverage run the test with:
204157

205-
```sh
206-
pytest --cov-report term-missing
207-
```
208-
209-
or
210-
211158
```sh
212159
poetry run pytest --cov-report term-missing
213160
```
@@ -217,12 +164,6 @@ tests are passing before submitting a pull request.
217164

218165
tox can be used to run both linting, and run the tests in all versions of Python async-search-client supports. Note that you will need to have all the verions of Python installed for this to work.
219166

220-
```sh
221-
tox
222-
```
223-
224-
or
225-
226167
```sh
227168
poetry run tox
228169
```

0 commit comments

Comments
 (0)