Newer
Older
How to contribute
=================
Write a patch
-------------
Phyks (Lucas Verney)
committed
Help yourself with the `documentation <http://docs.weboob.org/>`_.
Phyks (Lucas Verney)
committed
Find an opened issue on `this website <https://git.weboob.org/weboob/devel/issues>`_, or write your own bugfix or feature.
Then, once it is necessary, commit with::
Phyks (Lucas Verney)
committed
$ git commit -a
Do not forget to write a helpful commit message.
Check your patch
----------------
Phyks (Lucas Verney)
committed
You can run these scripts to be sure your patch doesn't break anything::
Phyks (Lucas Verney)
committed
$ tools/pyflakes.sh
$ tools/weboob_lint.sh
$ tools/run_tests.sh yourmodulename # or without yourmodulename to test everything
Phyks (Lucas Verney)
committed
Perhaps you should also write or fix tests. These tests are automatically run by
`Gitlab CI <https://git.weboob.org/weboob/devel/pipelines>`_ at each commit and merge requests.
Phyks (Lucas Verney)
committed
Create a merge request or send a patch
--------------------------------------
Phyks (Lucas Verney)
committed
The easiest way to send your patch is to create a fork on `the Weboob Gitlab <https://git.weboob.org>`_ and create a merge
request from there. This way, the code review process is easier and continuous integration is run automatically (see
previous section).
Phyks (Lucas Verney)
committed
If you prefer good old email patches, just use
Phyks (Lucas Verney)
committed
::
Phyks (Lucas Verney)
committed
$ git format-patch -n -s origin
Phyks (Lucas Verney)
committed
Then, send them with this command::
Phyks (Lucas Verney)
committed
$ git send-email --to=weboob@weboob.org *.patch
Phyks (Lucas Verney)
committed
You can also send the files by yourself if you haven't any configured MTA on your system.