diff options
| author | louiz’ <louiz@louiz.org> | 2016-10-25 01:17:58 +0200 |
|---|---|---|
| committer | louiz’ <louiz@louiz.org> | 2016-10-25 01:17:58 +0200 |
| commit | 5ffd976d7f36d7db530c1a518e4a5911404b4ba1 (patch) | |
| tree | 8e1188f3ea82cac80f0af2d0d4f4cf16061b51e8 | |
| parent | e5aaf7f8f4c1dc022be8626feaa91caf56fd72ba (diff) | |
| download | biboumi-5ffd976d7f36d7db530c1a518e4a5911404b4ba1.tar.gz biboumi-5ffd976d7f36d7db530c1a518e4a5911404b4ba1.tar.bz2 biboumi-5ffd976d7f36d7db530c1a518e4a5911404b4ba1.tar.xz biboumi-5ffd976d7f36d7db530c1a518e4a5911404b4ba1.zip | |
CONTRIBUTING.rst formatting and a typo
| -rw-r--r-- | CONTRIBUTING.rst | 22 |
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. |