You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Documentation HTML files can then be found in the `target/doc` directory.
47
57
48
-
If you wish to update the online documentation. Push directly to the `release` branch (or ask a maintainer to do so), this will trigger a Travis build that updates the documentation and WebAssembly demo page.
58
+
If you wish to update the online documentation, push directly to the `release` branch (or ask a maintainer to do so). This will trigger a Travis build that updates the documentation and WebAssembly demo page.
49
59
50
60
# Code organization
51
61
@@ -56,18 +66,20 @@ If you wish to update the online documentation. Push directly to the `release` b
56
66
-`obj`: python builtin types
57
67
-`src`: using the other subcrates to bring rustpython to life.
58
68
-`docs`: documentation (work in progress)
59
-
-`py_code_object`: CPython bytecode to rustpython bytecode convertor (work in progress)
69
+
-`py_code_object`: CPython bytecode to rustpython bytecode converter (work in progress)
60
70
-`wasm`: Binary crate and resources for WebAssembly build
61
71
-`tests`: integration test snippets
62
72
63
73
# Contributing
64
74
65
-
To start contributing, there are a lot of things that need to be done.
75
+
Contributions are more than welcome, and in many cases we are happy to guide contributors through PRs or on gitter.
76
+
77
+
With that in mind, please note this project is maintained by volunteers, some of the best ways to get started are below:
66
78
67
79
Most tasks are listed in the [issue tracker](https://github.com/RustPython/RustPython/issues).
68
80
Check issues labeled with `good first issue` if you wish to start coding.
69
81
70
-
Another approach is to checkout the sourcecode: builtin functions and object methods are often the simplest
82
+
Another approach is to checkout the source code: builtin functions and object methods are often the simplest
71
83
and easiest way to contribute.
72
84
73
85
You can also simply run
@@ -81,11 +93,11 @@ To test rustpython, there is a collection of python snippets located in the
81
93
82
94
```shell
83
95
$ cd tests
84
-
$ pipenv shell
85
-
$ pytest -v
96
+
$ pipenv install
97
+
$ pipenv run pytest -v
86
98
```
87
99
88
-
There also are some unittests, you can run those will cargo:
100
+
There also are some unit tests, you can run those will cargo:
0 commit comments