CONTRIBUTING.rst formatting and a typo
This commit is contained in:
+12
-10
@@ -3,16 +3,17 @@ Contributing to biboumi
|
|||||||
|
|
||||||
Biboumi’s main workplace is at https://lab.louiz.org/louiz/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
|
The repository is also mirrored on other websites, for example on github,
|
||||||
that’s mainly for the convenience of users.
|
but that’s mainly for the convenience of users.
|
||||||
|
|
||||||
Before doing anything, you can come on the `XMPP chatroom`_ to discuss your
|
Before doing anything, you can come on the `XMPP chatroom`_ to discuss your
|
||||||
changes, issues or ideas.
|
changes, issues or ideas.
|
||||||
|
|
||||||
Bug reports, feature requests
|
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
|
If the issue you’re reporting may have security implications, please select
|
||||||
the “confidential” flag in your bug report.
|
the “confidential” flag in your bug report.
|
||||||
@@ -20,15 +21,16 @@ the “confidential” flag in your bug report.
|
|||||||
|
|
||||||
Code
|
Code
|
||||||
----
|
----
|
||||||
|
|
||||||
To contribute code, you can do so using git: commit your changes on any
|
To contribute code, you can do so using git: commit your changes on any
|
||||||
publicly available git repository and communicate us its address. This
|
publicly available git repository and communicate us its address. This can
|
||||||
can be done with a `gitlab merge request`_, or a `github pull request`_
|
be done with a `gitlab merge request`_, or a `github pull request`_ or just
|
||||||
or just by sending a message into the `XMPP chatroom`_.
|
by sending a message into the `XMPP chatroom`_.
|
||||||
|
|
||||||
It is suggested that you use gitlab’s merge requests: this will automatically
|
It is suggested that you use gitlab’s merge requests: this will
|
||||||
run our continuous integration tests.
|
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.
|
changes.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user