CONTRIBUTING.md 1.37 KB
Newer Older
Romain Bignon's avatar
Romain Bignon committed
1 2 3 4 5 6
How to contribute
=================

Write a patch
-------------

7
Help yourself with the `documentation <http://docs.weboob.org/>`_.
Romain Bignon's avatar
Romain Bignon committed
8

9 10
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::
Romain Bignon's avatar
Romain Bignon committed
11

12
    $ git commit -a
Romain Bignon's avatar
Romain Bignon committed
13 14 15 16 17 18

Do not forget to write a helpful commit message.

Check your patch
----------------

19
You can run these scripts to be sure your patch doesn't break anything::
Romain Bignon's avatar
Romain Bignon committed
20

21 22 23
    $ tools/pyflakes.sh
    $ tools/weboob_lint.sh
    $ tools/run_tests.sh yourmodulename  # or without yourmodulename to test everything
Romain Bignon's avatar
Romain Bignon committed
24

25 26
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.
Romain Bignon's avatar
Romain Bignon committed
27

28 29
Create a merge request or send a patch
--------------------------------------
Romain Bignon's avatar
Romain Bignon committed
30

31 32 33
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).
Romain Bignon's avatar
Romain Bignon committed
34

35
If you prefer good old email patches, just use
Romain Bignon's avatar
Romain Bignon committed
36

37
::
Romain Bignon's avatar
Romain Bignon committed
38

39
    $ git format-patch -n -s origin
Romain Bignon's avatar
Romain Bignon committed
40

41
Then, send them with this command::
Romain Bignon's avatar
Romain Bignon committed
42

43
    $ git send-email --to=weboob@weboob.org *.patch
Romain Bignon's avatar
Romain Bignon committed
44

45
You can also send the files by yourself if you haven't any configured MTA on your system.