mirror of
https://github.com/microsoft/debugpy.git
synced 2025-12-23 08:48:12 +00:00
82 lines
3.3 KiB
Markdown
82 lines
3.3 KiB
Markdown
# Contributing to `ptvsd`
|
|
|
|
[](https://ptvsd.visualstudio.com/ptvsd/ptvsd%20Team/_build/index?definitionId=1)
|
|
[](https://travis-ci.org/Microsoft/ptvsd)
|
|
[](https://raw.githubusercontent.com/Microsoft/ptvsd/master/LICENSE)
|
|
[](https://pypi.org/project/ptvsd/)
|
|
|
|
|
|
## Contributing a pull request
|
|
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.microsoft.com.
|
|
|
|
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
|
|
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
|
|
provided by the bot. You will only need to do this once across all repos using our CLA.
|
|
|
|
### Prerequisites
|
|
Use [test_requirements.txt](test_requirements.txt) file to install the packages needed to run tests:
|
|
```console
|
|
pip install -r test_requirements.txt
|
|
```
|
|
|
|
### Linting
|
|
We use `flake8` for linting, and the settings can be found here [flake8](flake8)
|
|
|
|
### Formatting
|
|
This is optional. Use the following settings for `autopep8` or equivalent settings with the formatter of your choice:
|
|
VSC Python settings for formating:
|
|
```json
|
|
"python.formatting.provider": "autopep8",
|
|
"python.formatting.autopep8Args": [
|
|
"--ignore", "E24,E121,E123,E125,E126,E221,E226,E266,E704,E265,E722,E501,E731,E306,E401,E302,E222"
|
|
],
|
|
```
|
|
|
|
### Running `pytest` based tests
|
|
We are currently migrating the tests to use `pytest`. Please run both set of tests. Newer tests must go into the [pytests](pytests) directory. Use [test_requirements.txt](test_requirements.txt) to install packages needed to run the tests.
|
|
#### Windows
|
|
```
|
|
C:\> git clone https://github.com/Microsoft/ptvsd
|
|
C:\> cd ptvsd
|
|
C:\ptvsd> py -3.7 -m pip install -r test_requirements.txt
|
|
C:\ptvsd> py -3.7 -m pytest -v
|
|
```
|
|
#### Linux\Mac
|
|
```
|
|
~: git clone https://github.com/Microsoft/ptvsd
|
|
~: cd ptvsd
|
|
~/ptvsd: python3 -m pip install -r ./test_requirements.txt
|
|
~/ptvsd: python3 -m pytest -v
|
|
```
|
|
### Running `unittest` based tests
|
|
`git clone` ptvsd and change directory to `ptvsd`. Run the `tests` module from there. Newer tests must be written using `pytest` and must go into the [pytests](pytests) directory. Please do not add tests to this directory.
|
|
#### Windows
|
|
```
|
|
C:\> git clone https://github.com/Microsoft/ptvsd
|
|
C:\> cd ptvsd
|
|
C:\ptvsd> py -3.7 -m tests -v
|
|
```
|
|
#### Linux\Mac
|
|
```
|
|
~: git clone https://github.com/Microsoft/ptvsd
|
|
~: cd ptvsd
|
|
~/ptvsd: python3 -m tests -v
|
|
```
|
|
|
|
### Debug in VSC using development version
|
|
Set `PYTHONPATH` to point to cloned version of ptvsd, in `launch.json`, to debug any python project to test the debugger you are working on:
|
|
```json
|
|
{
|
|
"name": "Terminal (integrated)",
|
|
"type": "python",
|
|
"request": "launch",
|
|
"pythonPath": "${config:python.pythonPath}",
|
|
"program": "${file}",
|
|
"cwd": "${workspaceFolder}",
|
|
"console": "integratedTerminal",
|
|
"env": {"PYTHONPATH":"C:\\GIT\\ptvsd"},
|
|
"internalConsoleOptions": "neverOpen",
|
|
},
|
|
```
|