|
1 | | -### Contributing to the GraalVM Implementation of Python |
| 1 | +# Contributing GraalPython |
2 | 2 |
|
3 | 3 | Thanks for considering to contribute! To get you started, here is a bit of |
4 | 4 | information about the structure of this implementation. |
5 | 5 |
|
6 | | -##### But first... |
7 | | - |
8 | | -You will need to sign the [Oracle Contributor |
9 | | -Agreement](http://www.graalvm.org/community/contributors/) for us to be able to |
| 6 | +You will need to sign the [Oracle Contributor Agreement](http://www.graalvm.org/community/contributors/) for us to be able to |
10 | 7 | merge your work. |
11 | 8 |
|
12 | | -Please also take some time to review our [code of |
13 | | -conduct](http://www.graalvm.org/community/conduct/) for contributors. |
| 9 | +Please also take some time to review our [code of conduct](http://www.graalvm.org/community/conduct/) for contributors. |
14 | 10 |
|
15 | 11 | ##### Getting started |
16 | 12 |
|
@@ -83,20 +79,24 @@ modules that we have adapted from C Python. |
83 | 79 | ##### Debug options |
84 | 80 |
|
85 | 81 | The GraalVM implementation of Python provides proper debug options. It is possible to either debug the Python code, using Chrome debugger, |
86 | | -or the java code, using your preferred IDE. |
| 82 | +or the java code, using your preferred IDE. |
87 | 83 | The following commands should be executed in a virtualenv environment, which provides a graalpython executable. |
88 | 84 |
|
89 | 85 | For debug Python side code call this: |
90 | 86 |
|
91 | | -```graalpython --inspect your_script.py ``` |
| 87 | +``` |
| 88 | +graalpython --inspect your_script.py |
| 89 | +``` |
92 | 90 |
|
93 | 91 | This will open a debug server, which can be accessed in Chrome Browser under URL `chrome://inspect`. |
94 | 92 |
|
95 | 93 | For debugging java implemented code execute: |
96 | 94 |
|
97 | | -```graalpython --experimental-options -debug-java your_script.py``` |
| 95 | +``` |
| 96 | +graalpython --experimental-options -debug-java your_script.py |
| 97 | +``` |
98 | 98 |
|
99 | | -The command will also start a debug server, which can be used in an IDE. If the IDE was initialized properly |
| 99 | +The command will also start a debug server, which can be used in an IDE. If the IDE was initialized properly |
100 | 100 | by using the command mentioned above, the existing `GraalDebug` run configuration can be used to debug. |
101 | 101 |
|
102 | 102 | ### Advanced commands to develop and debug |
|
0 commit comments