summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst22
1 files changed, 12 insertions, 10 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index dfafa89..ed3915f 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -3,16 +3,17 @@ Contributing to biboumi
Biboumi’s main workplace is at https://lab.louiz.org/louiz/biboumi
-The repository is also mirrored on other websites, for example on github, but
-that’s mainly for the convenience of users.
+The repository is also mirrored on other websites, for example on github,
+but that’s mainly for the convenience of users.
Before doing anything, you can come on the `XMPP chatroom`_ to discuss your
changes, issues or ideas.
Bug reports, feature requests
-----------------------------
-To open a bug report, or a feature request, please do so on
-`our gitlab’s bug tracker`_.
+
+To open a bug report, or a feature request, please do so on `our gitlab’s
+bug tracker`_.
If the issue you’re reporting may have security implications, please select
the “confidential” flag in your bug report.
@@ -20,15 +21,16 @@ the “confidential” flag in your bug report.
Code
----
+
To contribute code, you can do so using git: commit your changes on any
-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`_.
+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`_.
-It is suggested that you use gitlab’s merge requests: this will automatically
-run our continuous integration tests.
+It is suggested that you use gitlab’s merge requests: this will
+automatically run our continuous integration tests.
-It is also recommended to add some unit or end-to-end tests for the prosposed
+It is also recommended to add some unit or end-to-end tests for the proposed
changes.