CONTRIBUTING.md 2.47 KB
Newer Older
Romain Bignon's avatar
Romain Bignon committed
1
2
3
How to contribute
=================

4
5
6
7
8
9
10
11
12
13
Whenever you start working on a bug or an issue, please mention it in the
corresponding issue on this repo. If there is not an already opened issue for
this bug, please open a MR as soon as possible (with the `WIP:` prefix
mentionning it is a work in progress) to let others know you are working on
this module and fixing things.

This way, everyone is aware of the changes you are making and this avoid doing
a lot of duplicate work.


Romain Bignon's avatar
Romain Bignon committed
14
15
16
Write a patch
-------------

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

19
20
21
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
22

23
    $ git commit -a
Romain Bignon's avatar
Romain Bignon committed
24
25
26

Do not forget to write a helpful commit message.

27

Romain Bignon's avatar
Romain Bignon committed
28
29
30
Check your patch
----------------

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

33
34
35
    $ 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
36

37
38
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
39

40

41
42
Create a merge request or send a patch
--------------------------------------
Romain Bignon's avatar
Romain Bignon committed
43

44
45
46
47
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
48

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

51
::
Romain Bignon's avatar
Romain Bignon committed
52

53
    $ git format-patch -n -s origin
Romain Bignon's avatar
Romain Bignon committed
54

55
Then, send them with this command::
Romain Bignon's avatar
Romain Bignon committed
56

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

59
You can also send the files by yourself if you haven't any configured MTA on your system.
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76


Notes on merging a merge request
--------------------------------

Few people (members of the [Weboob group on this
repo](https://git.weboob.org/groups/weboob/group_members)) have the right to
merge a MR.

Anyone is welcome to review and comment pending merge requests. A merge
request should in principle have at least two reviewers before getting merged.

Weboob `devel` repo should keep an history as linear as possible. Then,
merging a merge request should be done locally, with prior rebasing upon the
`master` branch and take care of using the `-ff-only` merge option. Merge
requests should **NOT** be merged through the Gitlab UI, which would result in
an extra "merge" commit.