File tree Expand file tree Collapse file tree 1 file changed +38
-0
lines changed Expand file tree Collapse file tree 1 file changed +38
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contributing to pybricksdev
2+
3+ ` pybricksdev ` is open source software and we welcome contributions.
4+
5+
6+ ## Developer environment
7+
8+ This is the preferred workflow that we support. If you have other tools you like
9+ to use, you are welcome to use them, but we can't help you if things go wrong.
10+
11+ ### Prerequisites
12+
13+ - [ Git] ( https://git-scm.com/ ) (or install ` git ` with your favorite package manager)
14+ - [ Python 3.8] ( https://python.org ) (see [ README] ( ./README.md ) for more info)
15+ - [ Poetry] ( https://python-poetry.org/ )
16+ - [ VS Code] ( https://code.visualstudio.com/ )
17+
18+ ### Get the code and setup the environment
19+
20+ After installing the prerequisites, use a command prompt in the location of your
21+ choice to run the following:
22+
23+ git clone https://github.com/pybricks/pybricksdev
24+ cd pybricksdev
25+ poetry env use python3.8
26+ poetry install
27+ code .
28+
29+ On Windows, you may need to use the full path to ` python3.8 ` (run ` py -0p ` to find it).
30+
31+ You will need to tell VS Code to use ` .venv ` as the Python interpreter. It
32+ should ask you about this the first time you open the project folder.
33+
34+ You should also opt into the [ DeprecatePythonPath] experiment for the Microsoft
35+ Python VS Code extension so that it does not modify the ` .vscode/settings.json `
36+ file in the project when you select the interpreter.
37+
38+ [ DeprecatePythonPath ] : https://github.com/microsoft/vscode-python/wiki/AB-Experiments#deprecatepythonpath
You can’t perform that action at this time.
0 commit comments