[vlc-commits] python: add a How to contribute section

[Olivier Aubert]

vlc/python | branch: master | Olivier Aubert <contact at olivieraubert.net> | Tue Mar  3 15:55:34 2020 +0100| [b47767b565843d2dd3acadd31432fa0f9b63536d] | committer: Olivier Aubert

python: add a How to contribute section

> http://git.videolan.org/gitweb.cgi/vlc/python.git/?a=commit;h=b47767b565843d2dd3acadd31432fa0f9b63536d
---

 README.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.rst b/README.rst
index 86c16c8..a0d28e6 100644
--- a/README.rst
+++ b/README.rst
@@ -68,3 +68,17 @@ To generate the reference PyPI module (including setup.py, examples
 and metadata files), use
 
     make dist
+
+How to contribute
+-----------------
+
+There are short-terms contributions (reporting and fixing bugs,
+contributing unit tests, contributing examples). A number of libvlc
+functions are currently blacklisted (search for `_blacklist` in the
+generator code), mostly because of their signature complexity. They
+would benefit some work.
+
+Longer terms goals include the rewriting of the generator to use a
+proper parser for the C-syntax (for the moment, the parser relies on
+regexp-based expression, which works thanks to the coding style
+applied in the code, but remains very fragile).