Contribute¶
Python-guide is under active development, and contributors are welcome.
If you have a feature request, suggestion, or bug report, please open a new issue on GitHub. To submit patches, please send a pull request on GitHub. Once your changes get merged back in, you’ll automatically be added to the Contributors List.
Style Guide¶
For all contributions, please follow the The Guide Style Guide.
Todo List¶
If you’d like to contribute, there’s plenty to do. Here’s a short todo list.
- Establish “use this” vs “alternatives are....” recommendations
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/scenarios/admin.rst, line 239.)
Todo
Write about Blueprint
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/scenarios/admin.rst, line 343.)
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/scenarios/admin.rst, line 348.)
Todo
Add introduction about image manipulation and its Python libraries.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/scenarios/imaging.rst, line 5.)
Todo
Write about Numba and the autojit compiler for NumPy
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/scenarios/speed.rst, line 227.)
Todo
Fill in “Freezing Your Code” stub
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/shipping/freezing.rst, line 13.)
Todo
Write steps for most basic .exe
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/shipping/freezing.rst, line 50.)
Todo
Embed and explain YouTube video showing python code reading: http://www.youtube.com/watch?v=Jc8M9-LoEuo This may require installing a Sphinx plugin. https://bitbucket.org/birkenfeld/sphinx-contrib/src/a09f29fc16970f34350ca36ac7f229e00b1b1674/youtube?at=default
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/writing/reading.rst, line 41.)
Todo
Include code examples of exemplary code from each of the projects listed. Explain why it is excellent code. Use complex examples.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/writing/reading.rst, line 43.)
Todo
Explain techniques to rapidly identify data structures, algorithms and determine what the code is doing.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/python-guide/checkouts/latest/docs/writing/reading.rst, line 45.)
