CONTRIBUTING.rst 1.88 KB
Newer Older
louiz’'s avatar
louiz’ committed
1 2 3 4 5
Contributing to biboumi
=======================

Biboumi’s main workplace is at https://lab.louiz.org/louiz/biboumi

6 7
The repository is also mirrored on other websites, for example on github,
but that’s mainly for the convenience of users.
louiz’'s avatar
louiz’ committed
8 9 10 11

Before doing anything, you can come on the `XMPP chatroom`_ to discuss your
changes, issues or ideas.

12

louiz’'s avatar
louiz’ committed
13 14
Bug reports, feature requests
-----------------------------
15 16 17

To open a bug report, or a feature request, please do so on `our gitlab’s
bug tracker`_.
louiz’'s avatar
louiz’ committed
18

19 20 21 22
If the bug you’re reporting is about a bad behaviour of biboumi when some XMPP
or IRC events occur, please try to reproduce the issue with a biboumi running
in log_level=0, and include the relevant logs in your bug report.

louiz’'s avatar
louiz’ committed
23 24 25 26 27 28
If the issue you’re reporting may have security implications, please select
the “confidential” flag in your bug report.


Code
----
29

louiz’'s avatar
louiz’ committed
30
To contribute code, you can do so using git: commit your changes on any
31 32 33
publicly available git repository and communicate us its address.  This can
be done with a `gitlab merge request`_, or a `github pull request`_ or just
by sending a message into the `XMPP chatroom`_.
louiz’'s avatar
louiz’ committed
34

35 36
It is suggested that you use gitlab’s merge requests: this will
automatically run our continuous integration tests.
37

38
It is also recommended to add some unit or end-to-end tests for the proposed
39 40
changes.

louiz’'s avatar
louiz’ committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

Coding style
------------
Please try to follow the existing style:

- Use only spaces, not tabs.
- Curly brackets are on their own lines.
- Use this-> everywhere it’s possible.
- Don’t start class attributes with “m_” or similar.
- Type names are in PascalCase.
- Everything else is in snake_case.


.. _our gitlab’s bug tracker: https://lab.louiz.org/louiz/biboumi/issues/new
.. _gitlab merge request: https://lab.louiz.org/louiz/biboumi/merge_requests/new
.. _github pull request: https://github.com/louiz/biboumi/pulls
.. _XMPP chatroom: xmpp:biboumi@muc.poez.io