Skip to content

Commit 246aed8

Browse files
docs: Merge development.md into CONTRIBUTING.md (microsoft#504)
1 parent 9b5bd50 commit 246aed8

File tree

2 files changed

+30
-52
lines changed

2 files changed

+30
-52
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,46 @@
44

55
### Configuring python environment
66

7-
The project requires python version 3.8+. To set it as default in the environment run the following commands:
7+
The project requires Python version 3.7+. To set it as default in the environment run the following commands:
88

9-
```bash
10-
python3.8 -m venv env
9+
```sh
10+
python -m venv env
1111
source ./env/bin/activate
1212
```
1313

1414
Install required dependencies:
1515

16-
```bash
16+
```sh
1717
python -m pip install --upgrade pip wheel
1818
pip install -r local-requirements.txt
19-
pip install -e .
19+
```
20+
21+
Build and install drivers:
22+
23+
```sh
24+
pip install -e.
2025
python setup.py bdist_wheel
2126
```
2227

28+
Run tests:
29+
30+
```sh
31+
pytest
32+
```
33+
34+
Checking for typing errors
35+
36+
```sh
37+
mypy playwright
38+
```
39+
40+
Format the code
41+
42+
```sh
43+
pre-commit install
44+
pre-commit run --all-files
45+
```
46+
2347
For more details look at the [CI configuration](./blob/master/.github/workflows/ci.yml).
2448

2549
### Regenerating APIs
@@ -31,7 +55,7 @@ pre-commit run --all-files
3155

3256
## Contributor License Agreement
3357

34-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
58+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
3559
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
3660
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
3761

docs/development.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)