Skip to content

docs: Merge development.md into CONTRIBUTING.md #504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 25, 2021
Merged

docs: Merge development.md into CONTRIBUTING.md #504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 30 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,46 @@

### Configuring python environment

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

```bash
python3.8 -m venv env
```sh
python -m venv env
source ./env/bin/activate
```

Install required dependencies:

```bash
```sh
python -m pip install --upgrade pip wheel
pip install -r local-requirements.txt
pip install -e .
```

Build and install drivers:

```sh
pip install -e.
python setup.py bdist_wheel
```

Run tests:

```sh
pytest
```

Checking for typing errors

```sh
mypy playwright
```

Format the code

```sh
pre-commit install
pre-commit run --all-files
```

For more details look at the [CI configuration](./blob/master/.github/workflows/ci.yml).

### Regenerating APIs
Expand All @@ -31,7 +55,7 @@ pre-commit run --all-files

## Contributor License Agreement

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

Expand Down
46 changes: 0 additions & 46 deletions docs/development.md
View file
Open in desktop

This file was deleted.